Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/type-aliases/EnhancedGenerateResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **EnhancedGenerateResult** = [`GenerateResult`](GenerateResult.md) & `object`

Defined in: [types/generate.ts:1756](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1756)
Defined in: [types/generate.ts:1765](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1765)

## Type Declaration

Expand Down
2 changes: 1 addition & 1 deletion docs/api/type-aliases/GenerateOptionsNormalized.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **GenerateOptionsNormalized** = [`GenerateOptions`](GenerateOptions.md) & `object`

Defined in: [types/generate.ts:1783](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1783)
Defined in: [types/generate.ts:1792](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1792)

Internal alias used by messageBuilder helpers after the entry-point
(`buildMultimodalMessagesArray`) has guaranteed that `input` is non-null.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/type-aliases/ModelAliasConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **ModelAliasConfig** = `object`

Defined in: [types/generate.ts:1766](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1766)
Defined in: [types/generate.ts:1775](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1775)

NL-004: Model alias/deprecation configuration.
Allows mapping deprecated model names to their replacements.
Expand All @@ -19,4 +19,4 @@ Allows mapping deprecated model names to their replacements.

> **aliases**: `Record`\<`string`, \{ `target`: `string`; `action`: `"warn"` \| `"redirect"` \| `"block"`; `reason?`: `string`; \}\>

Defined in: [types/generate.ts:1767](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1767)
Defined in: [types/generate.ts:1776](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1776)
28 changes: 14 additions & 14 deletions docs/api/type-aliases/NativeGenerateLoopArgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **NativeGenerateLoopArgs** = `object`

Defined in: [types/generate.ts:1792](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1792)
Defined in: [types/generate.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1801)

Inputs to the shared native generate loop (`core/nativeGenerateLoop.ts`).
One loop serves every provider whose delegating model exposes a v3-shaped
Expand All @@ -20,7 +20,7 @@ One loop serves every provider whose delegating model exposes a v3-shaped

> **doGenerate**: (`options`) => `Promise`\<`Record`\<`string`, `unknown`\>\>

Defined in: [types/generate.ts:1793](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1793)
Defined in: [types/generate.ts:1802](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1802)

#### Parameters

Expand All @@ -38,7 +38,7 @@ Defined in: [types/generate.ts:1793](https://github.com/juspay/neurolink/blob/re

> **conversation**: `Record`\<`string`, `unknown`\>[]

Defined in: [types/generate.ts:1797](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1797)
Defined in: [types/generate.ts:1806](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1806)

Conversation in the message-builder shape each doGenerate converts itself.

Expand All @@ -48,7 +48,7 @@ Conversation in the message-builder shape each doGenerate converts itself.

> `optional` **tools?**: `Record`\<`string`, `unknown`\>[]

Defined in: [types/generate.ts:1799](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1799)
Defined in: [types/generate.ts:1808](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1808)

Tool declarations in the v3 shape doGenerate already knows how to convert.

Expand All @@ -58,7 +58,7 @@ Tool declarations in the v3 shape doGenerate already knows how to convert.

> **toolsRecord**: `Record`\<`string`, `unknown`\>

Defined in: [types/generate.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1801)
Defined in: [types/generate.ts:1810](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1810)

Registered tools, used to execute a call the model asks for.

Expand All @@ -68,63 +68,63 @@ Registered tools, used to execute a call the model asks for.

> `optional` **toolChoice?**: `unknown`

Defined in: [types/generate.ts:1802](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1802)
Defined in: [types/generate.ts:1811](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1811)

---

### responseFormat?

> `optional` **responseFormat?**: `Record`\<`string`, `unknown`\>

Defined in: [types/generate.ts:1803](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1803)
Defined in: [types/generate.ts:1812](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1812)

---

### providerOptions?

> `optional` **providerOptions?**: `Record`\<`string`, `Record`\<`string`, `unknown`\>\>

Defined in: [types/generate.ts:1804](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1804)
Defined in: [types/generate.ts:1813](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1813)

---

### maxSteps

> **maxSteps**: `number`

Defined in: [types/generate.ts:1805](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1805)
Defined in: [types/generate.ts:1814](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1814)

---

### maxOutputTokens?

> `optional` **maxOutputTokens?**: `number`

Defined in: [types/generate.ts:1806](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1806)
Defined in: [types/generate.ts:1815](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1815)

---

### temperature?

> `optional` **temperature?**: `number`

Defined in: [types/generate.ts:1807](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1807)
Defined in: [types/generate.ts:1816](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1816)

---

### abortSignal?

> `optional` **abortSignal?**: `AbortSignal`

Defined in: [types/generate.ts:1808](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1808)
Defined in: [types/generate.ts:1817](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1817)

---

### toolTimeoutMs?

> `optional` **toolTimeoutMs?**: `number` \| `null`

Defined in: [types/generate.ts:1810](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1810)
Defined in: [types/generate.ts:1819](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1819)

Per-tool-execution cap, forwarded into `guardToolExecutor`. `null` for no bound.

Expand All @@ -134,7 +134,7 @@ Per-tool-execution cap, forwarded into `guardToolExecutor`. `null` for no bound.

> **runStep**: (`call`) => `Promise`\<`Record`\<`string`, `unknown`\>\>

Defined in: [types/generate.ts:1812](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1812)
Defined in: [types/generate.ts:1821](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1821)

Wraps one step: retry ladder plus provider error classification.

Expand Down
22 changes: 11 additions & 11 deletions docs/api/type-aliases/NativeGenerateLoopResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@

> **NativeGenerateLoopResult** = `object`

Defined in: [types/generate.ts:1817](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1817)
Defined in: [types/generate.ts:1826](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1826)

## Properties

### text

> **text**: `string`

Defined in: [types/generate.ts:1818](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1818)
Defined in: [types/generate.ts:1827](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1827)

---

### reasoning?

> `optional` **reasoning?**: `string`

Defined in: [types/generate.ts:1820](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1820)
Defined in: [types/generate.ts:1829](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1829)

Joined reasoning content parts from the final step, when the vendor sent any.

Expand All @@ -34,60 +34,60 @@ Joined reasoning content parts from the final step, when the vendor sent any.

> **finishReason**: `string`

Defined in: [types/generate.ts:1821](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1821)
Defined in: [types/generate.ts:1830](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1830)

---

### rawFinishReason?

> `optional` **rawFinishReason?**: `string`

Defined in: [types/generate.ts:1822](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1822)
Defined in: [types/generate.ts:1831](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1831)

---

### inputTokens

> **inputTokens**: `number`

Defined in: [types/generate.ts:1823](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1823)
Defined in: [types/generate.ts:1832](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1832)

---

### outputTokens

> **outputTokens**: `number`

Defined in: [types/generate.ts:1824](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1824)
Defined in: [types/generate.ts:1833](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1833)

---

### cacheReadTokens

> **cacheReadTokens**: `number`

Defined in: [types/generate.ts:1825](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1825)
Defined in: [types/generate.ts:1834](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1834)

---

### cacheWriteTokens

> **cacheWriteTokens**: `number`

Defined in: [types/generate.ts:1826](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1826)
Defined in: [types/generate.ts:1835](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1835)

---

### toolsUsed

> **toolsUsed**: `string`[]

Defined in: [types/generate.ts:1827](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1827)
Defined in: [types/generate.ts:1836](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1836)

---

### steps

> **steps**: `number`

Defined in: [types/generate.ts:1828](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1828)
Defined in: [types/generate.ts:1837](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1837)
12 changes: 6 additions & 6 deletions docs/api/type-aliases/SingleShotRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,44 +8,44 @@

> **SingleShotRequest** = `object`

Defined in: [types/generate.ts:1831](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1831)
Defined in: [types/generate.ts:1840](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1840)

## Properties

### system?

> `optional` **system?**: `string`

Defined in: [types/generate.ts:1832](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1832)
Defined in: [types/generate.ts:1841](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1841)

---

### prompt

> **prompt**: `string`

Defined in: [types/generate.ts:1833](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1833)
Defined in: [types/generate.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1842)

---

### maxOutputTokens?

> `optional` **maxOutputTokens?**: `number`

Defined in: [types/generate.ts:1834](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1834)
Defined in: [types/generate.ts:1843](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1843)

---

### temperature?

> `optional` **temperature?**: `number`

Defined in: [types/generate.ts:1835](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1835)
Defined in: [types/generate.ts:1844](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1844)

---

### abortSignal?

> `optional` **abortSignal?**: `AbortSignal`

Defined in: [types/generate.ts:1836](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1836)
Defined in: [types/generate.ts:1845](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1845)
8 changes: 4 additions & 4 deletions docs/api/type-aliases/SingleShotResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@

> **SingleShotResult** = `object`

Defined in: [types/generate.ts:1839](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1839)
Defined in: [types/generate.ts:1848](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1848)

## Properties

### text

> **text**: `string`

Defined in: [types/generate.ts:1840](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1840)
Defined in: [types/generate.ts:1849](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1849)

---

### usage?

> `optional` **usage?**: `object`

Defined in: [types/generate.ts:1841](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1841)
Defined in: [types/generate.ts:1850](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1850)

#### inputTokens?

Expand All @@ -44,4 +44,4 @@ Defined in: [types/generate.ts:1841](https://github.com/juspay/neurolink/blob/re

> `optional` **finishReason?**: `string`

Defined in: [types/generate.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1842)
Defined in: [types/generate.ts:1851](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1851)
10 changes: 5 additions & 5 deletions docs/api/type-aliases/TTSMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **TTSMetadata** = `object`

Defined in: [types/generate.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1741)
Defined in: [types/generate.ts:1750](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1750)

Enhanced result type with optional analytics/evaluation

Expand All @@ -18,7 +18,7 @@ Enhanced result type with optional analytics/evaluation

> **attempted**: `boolean`

Defined in: [types/generate.ts:1743](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1743)
Defined in: [types/generate.ts:1752](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1752)

Whether TTS synthesis was invoked. False indicates TTS was skipped.

Expand All @@ -28,7 +28,7 @@ Whether TTS synthesis was invoked. False indicates TTS was skipped.

> **success**: `boolean`

Defined in: [types/generate.ts:1745](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1745)
Defined in: [types/generate.ts:1754](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1754)

Whether TTS synthesis completed successfully.

Expand All @@ -38,7 +38,7 @@ Whether TTS synthesis completed successfully.

> `optional` **error?**: `object`

Defined in: [types/generate.ts:1747](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1747)
Defined in: [types/generate.ts:1756](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1756)

Structured synthesis error details, present only when synthesis failed.

Expand All @@ -60,6 +60,6 @@ Structured synthesis error details, present only when synthesis failed.

> `optional` **latency?**: `number`

Defined in: [types/generate.ts:1753](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1753)
Defined in: [types/generate.ts:1762](https://github.com/juspay/neurolink/blob/release/src/lib/types/generate.ts#L1762)

TTS synthesis time in milliseconds.
Loading
Loading