diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md index 574e03ea5..534fa251c 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/BedrockClient.md @@ -8,7 +8,7 @@ > **BedrockClient** = `object` -Defined in: [types/providers.ts:1908](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1908) +Defined in: [types/providers.ts:1918](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1918) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1908](https://github.com/juspay/neurolink/blob/r > **config**: `object` -Defined in: [types/providers.ts:1910](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1910) +Defined in: [types/providers.ts:1920](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1920) #### region? @@ -32,7 +32,7 @@ Defined in: [types/providers.ts:1910](https://github.com/juspay/neurolink/blob/r > **send**(`command`): `Promise`\<`unknown`\> -Defined in: [types/providers.ts:1909](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1909) +Defined in: [types/providers.ts:1919](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1919) #### Parameters diff --git a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md index d190c3471..8c951c051 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/BedrockTypes/type-aliases/InvokeModelCommand.md @@ -8,7 +8,7 @@ > **InvokeModelCommand** = `object` -Defined in: [types/providers.ts:1917](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1917) +Defined in: [types/providers.ts:1927](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1927) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1917](https://github.com/juspay/neurolink/blob/r > **input**: `object` -Defined in: [types/providers.ts:1918](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1918) +Defined in: [types/providers.ts:1928](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1928) #### modelId diff --git a/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md b/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md index 6270fc84d..c5479b09f 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/MistralTypes/type-aliases/MistralClient.md @@ -8,7 +8,7 @@ > **MistralClient** = `object` -Defined in: [types/providers.ts:1931](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1931) +Defined in: [types/providers.ts:1941](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1941) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1931](https://github.com/juspay/neurolink/blob/r > `optional` **chat?**: `object` -Defined in: [types/providers.ts:1932](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1932) +Defined in: [types/providers.ts:1942](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1942) #### complete? diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md index ba44bc523..0aa79847d 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Counter.md @@ -8,7 +8,7 @@ > **Counter** = `object` -Defined in: [types/providers.ts:1952](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1952) +Defined in: [types/providers.ts:1962](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1962) ## Methods @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1952](https://github.com/juspay/neurolink/blob/r > **add**(`value`, `attributes?`): `void` -Defined in: [types/providers.ts:1953](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1953) +Defined in: [types/providers.ts:1963](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1963) #### Parameters diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md index 08ff7fe4a..8da3deb40 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Histogram.md @@ -8,7 +8,7 @@ > **Histogram** = `object` -Defined in: [types/providers.ts:1956](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1956) +Defined in: [types/providers.ts:1966](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1966) ## Methods @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1956](https://github.com/juspay/neurolink/blob/r > **record**(`value`, `attributes?`): `void` -Defined in: [types/providers.ts:1957](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1957) +Defined in: [types/providers.ts:1967](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1967) #### Parameters diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md index 2ad07f344..43fd2a293 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Meter.md @@ -8,7 +8,7 @@ > **Meter** = `object` -Defined in: [types/providers.ts:1943](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1943) +Defined in: [types/providers.ts:1953](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1953) ## Methods @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1943](https://github.com/juspay/neurolink/blob/r > **createCounter**(`name`, `options?`): [`Counter`](Counter.md) -Defined in: [types/providers.ts:1944](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1944) +Defined in: [types/providers.ts:1954](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1954) #### Parameters @@ -38,7 +38,7 @@ Defined in: [types/providers.ts:1944](https://github.com/juspay/neurolink/blob/r > **createHistogram**(`name`, `options?`): [`Histogram`](Histogram.md) -Defined in: [types/providers.ts:1945](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1945) +Defined in: [types/providers.ts:1955](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1955) #### Parameters diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md index 0aaa349c7..fb2b8e6f2 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Span.md @@ -8,7 +8,7 @@ > **Span** = `object` -Defined in: [types/providers.ts:1960](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1960) +Defined in: [types/providers.ts:1970](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1970) ## Methods @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1960](https://github.com/juspay/neurolink/blob/r > **end**(): `void` -Defined in: [types/providers.ts:1961](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1961) +Defined in: [types/providers.ts:1971](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1971) #### Returns @@ -28,7 +28,7 @@ Defined in: [types/providers.ts:1961](https://github.com/juspay/neurolink/blob/r > **setStatus**(`status`): `void` -Defined in: [types/providers.ts:1962](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1962) +Defined in: [types/providers.ts:1972](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1972) #### Parameters @@ -46,7 +46,7 @@ Defined in: [types/providers.ts:1962](https://github.com/juspay/neurolink/blob/r > **recordException**(`exception`): `void` -Defined in: [types/providers.ts:1963](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1963) +Defined in: [types/providers.ts:1973](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1973) #### Parameters diff --git a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md index cb3487599..39e631dd3 100644 --- a/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md +++ b/docs/api/NeuroLink-API-Reference/namespaces/TelemetryTypes/type-aliases/Tracer.md @@ -8,7 +8,7 @@ > **Tracer** = `object` -Defined in: [types/providers.ts:1948](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1948) +Defined in: [types/providers.ts:1958](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1958) ## Methods @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1948](https://github.com/juspay/neurolink/blob/r > **startSpan**(`name`, `options?`): [`Span`](Span.md) -Defined in: [types/providers.ts:1949](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1949) +Defined in: [types/providers.ts:1959](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1959) #### Parameters diff --git a/docs/api/type-aliases/BatchInferenceConfig.md b/docs/api/type-aliases/BatchInferenceConfig.md index 7be2ba827..7bf0bafb4 100644 --- a/docs/api/type-aliases/BatchInferenceConfig.md +++ b/docs/api/type-aliases/BatchInferenceConfig.md @@ -8,7 +8,7 @@ > **BatchInferenceConfig** = `object` -Defined in: [types/providers.ts:1727](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1727) +Defined in: [types/providers.ts:1737](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1737) Batch inference job configuration @@ -18,7 +18,7 @@ Batch inference job configuration > **inputS3Uri**: `string` -Defined in: [types/providers.ts:1729](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1729) +Defined in: [types/providers.ts:1739](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1739) Input S3 location @@ -28,7 +28,7 @@ Input S3 location > **outputS3Uri**: `string` -Defined in: [types/providers.ts:1731](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1731) +Defined in: [types/providers.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1741) Output S3 location @@ -38,7 +38,7 @@ Output S3 location > **modelName**: `string` -Defined in: [types/providers.ts:1733](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1733) +Defined in: [types/providers.ts:1743](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1743) SageMaker model name @@ -48,7 +48,7 @@ SageMaker model name > **instanceType**: `string` -Defined in: [types/providers.ts:1735](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1735) +Defined in: [types/providers.ts:1745](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1745) Instance type for batch job @@ -58,7 +58,7 @@ Instance type for batch job > **instanceCount**: `number` -Defined in: [types/providers.ts:1737](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1737) +Defined in: [types/providers.ts:1747](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1747) Instance count for batch job @@ -68,7 +68,7 @@ Instance count for batch job > `optional` **maxPayloadInMB?**: `number` -Defined in: [types/providers.ts:1739](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1739) +Defined in: [types/providers.ts:1749](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1749) Maximum payload size in MB @@ -78,6 +78,6 @@ Maximum payload size in MB > `optional` **batchStrategy?**: `"MultiRecord"` \| `"SingleRecord"` -Defined in: [types/providers.ts:1741](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1741) +Defined in: [types/providers.ts:1751](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1751) Batch strategy diff --git a/docs/api/type-aliases/CollectedChunkResult.md b/docs/api/type-aliases/CollectedChunkResult.md index 703c20ab3..6e76a831d 100644 --- a/docs/api/type-aliases/CollectedChunkResult.md +++ b/docs/api/type-aliases/CollectedChunkResult.md @@ -8,7 +8,7 @@ > **CollectedChunkResult** = `object` -Defined in: [types/providers.ts:2060](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2060) +Defined in: [types/providers.ts:2070](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2070) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:2060](https://github.com/juspay/neurolink/blob/r > **rawResponseParts**: `unknown`[] -Defined in: [types/providers.ts:2061](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2061) +Defined in: [types/providers.ts:2071](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2071) --- @@ -24,7 +24,7 @@ Defined in: [types/providers.ts:2061](https://github.com/juspay/neurolink/blob/r > **stepFunctionCalls**: [`NativeFunctionCall`](NativeFunctionCall.md)[] -Defined in: [types/providers.ts:2062](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2062) +Defined in: [types/providers.ts:2072](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2072) --- @@ -32,7 +32,7 @@ Defined in: [types/providers.ts:2062](https://github.com/juspay/neurolink/blob/r > `optional` **finishReason?**: `string` -Defined in: [types/providers.ts:2064](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2064) +Defined in: [types/providers.ts:2074](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2074) Raw `Candidate.finishReason` from the last chunk that carried one. @@ -42,7 +42,7 @@ Raw `Candidate.finishReason` from the last chunk that carried one. > **inputTokens**: `number` -Defined in: [types/providers.ts:2065](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2065) +Defined in: [types/providers.ts:2075](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2075) --- @@ -50,7 +50,7 @@ Defined in: [types/providers.ts:2065](https://github.com/juspay/neurolink/blob/r > **outputTokens**: `number` -Defined in: [types/providers.ts:2066](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2066) +Defined in: [types/providers.ts:2076](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2076) --- @@ -58,7 +58,7 @@ Defined in: [types/providers.ts:2066](https://github.com/juspay/neurolink/blob/r > `optional` **cacheReadTokens?**: `number` -Defined in: [types/providers.ts:2072](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2072) +Defined in: [types/providers.ts:2082](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2082) Gemini cached-content tokens (overlapping: included in promptTokenCount). Surfaced so the call site can subtract from input and bill at cacheRead @@ -70,7 +70,7 @@ rate. Subtraction happens at the call site, not in the collector. > `optional` **cacheCreationTokens?**: `number` -Defined in: [types/providers.ts:2074](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2074) +Defined in: [types/providers.ts:2084](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2084) Cache creation tokens (symmetry; Gemini does not emit this). @@ -80,7 +80,7 @@ Cache creation tokens (symmetry; Gemini does not emit this). > `optional` **reasoningTokens?**: `number` -Defined in: [types/providers.ts:2080](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2080) +Defined in: [types/providers.ts:2090](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2090) Gemini thinking tokens (usageMetadata.thoughtsTokenCount). Billed at the output rate but NOT included in candidatesTokenCount — Gemini reports diff --git a/docs/api/type-aliases/CostEstimate.md b/docs/api/type-aliases/CostEstimate.md index a237e634b..b9047eaa8 100644 --- a/docs/api/type-aliases/CostEstimate.md +++ b/docs/api/type-aliases/CostEstimate.md @@ -8,7 +8,7 @@ > **CostEstimate** = `object` -Defined in: [types/providers.ts:1799](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1799) +Defined in: [types/providers.ts:1809](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1809) Cost estimation data @@ -18,7 +18,7 @@ Cost estimation data > **estimatedCost**: `number` -Defined in: [types/providers.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1801) +Defined in: [types/providers.ts:1811](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1811) Estimated cost in USD @@ -28,7 +28,7 @@ Estimated cost in USD > **currency**: `string` -Defined in: [types/providers.ts:1803](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1803) +Defined in: [types/providers.ts:1813](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1813) Currency code @@ -38,7 +38,7 @@ Currency code > **breakdown**: `object` -Defined in: [types/providers.ts:1805](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1805) +Defined in: [types/providers.ts:1815](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1815) Cost breakdown @@ -66,7 +66,7 @@ Total processing hours > `optional` **period?**: `object` -Defined in: [types/providers.ts:1814](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1814) +Defined in: [types/providers.ts:1824](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1824) Time period for estimate diff --git a/docs/api/type-aliases/DetectionTestConfig.md b/docs/api/type-aliases/DetectionTestConfig.md index ab18c458a..4ab96de9b 100644 --- a/docs/api/type-aliases/DetectionTestConfig.md +++ b/docs/api/type-aliases/DetectionTestConfig.md @@ -8,7 +8,7 @@ > **DetectionTestConfig** = `object` -Defined in: [types/providers.ts:2275](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2275) +Defined in: [types/providers.ts:2285](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2285) Configuration object for a detection test wrapper. @@ -18,7 +18,7 @@ Configuration object for a detection test wrapper. > **test**: () => `Promise`\<`void`\> -Defined in: [types/providers.ts:2276](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2276) +Defined in: [types/providers.ts:2286](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2286) #### Returns @@ -30,7 +30,7 @@ Defined in: [types/providers.ts:2276](https://github.com/juspay/neurolink/blob/r > **index**: `number` -Defined in: [types/providers.ts:2277](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2277) +Defined in: [types/providers.ts:2287](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2287) --- @@ -38,7 +38,7 @@ Defined in: [types/providers.ts:2277](https://github.com/juspay/neurolink/blob/r > **testName**: `string` -Defined in: [types/providers.ts:2278](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2278) +Defined in: [types/providers.ts:2288](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2288) --- @@ -46,7 +46,7 @@ Defined in: [types/providers.ts:2278](https://github.com/juspay/neurolink/blob/r > **endpointName**: `string` -Defined in: [types/providers.ts:2279](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2279) +Defined in: [types/providers.ts:2289](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2289) --- @@ -54,7 +54,7 @@ Defined in: [types/providers.ts:2279](https://github.com/juspay/neurolink/blob/r > **semaphore**: `object` -Defined in: [types/providers.ts:2280](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2280) +Defined in: [types/providers.ts:2290](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2290) #### acquire() @@ -78,7 +78,7 @@ Defined in: [types/providers.ts:2280](https://github.com/juspay/neurolink/blob/r > **incrementRateLimit**: () => `void` -Defined in: [types/providers.ts:2284](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2284) +Defined in: [types/providers.ts:2294](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2294) #### Returns @@ -90,7 +90,7 @@ Defined in: [types/providers.ts:2284](https://github.com/juspay/neurolink/blob/r > **maxRateLimitRetries**: `number` -Defined in: [types/providers.ts:2285](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2285) +Defined in: [types/providers.ts:2295](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2295) --- @@ -98,7 +98,7 @@ Defined in: [types/providers.ts:2285](https://github.com/juspay/neurolink/blob/r > **rateLimitState**: `object` -Defined in: [types/providers.ts:2286](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2286) +Defined in: [types/providers.ts:2296](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2296) #### count diff --git a/docs/api/type-aliases/DiagnosticReport.md b/docs/api/type-aliases/DiagnosticReport.md index 74faa8cca..738fcb038 100644 --- a/docs/api/type-aliases/DiagnosticReport.md +++ b/docs/api/type-aliases/DiagnosticReport.md @@ -8,7 +8,7 @@ > **DiagnosticReport** = `object` -Defined in: [types/providers.ts:2311](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2311) +Defined in: [types/providers.ts:2321](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2321) Aggregated SageMaker diagnostic report. @@ -18,7 +18,7 @@ Aggregated SageMaker diagnostic report. > **overallStatus**: `"healthy"` \| `"issues"` \| `"critical"` -Defined in: [types/providers.ts:2312](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2312) +Defined in: [types/providers.ts:2322](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2322) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2312](https://github.com/juspay/neurolink/blob/r > **results**: [`DiagnosticResult`](DiagnosticResult.md)[] -Defined in: [types/providers.ts:2313](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2313) +Defined in: [types/providers.ts:2323](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2323) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2313](https://github.com/juspay/neurolink/blob/r > **summary**: `object` -Defined in: [types/providers.ts:2314](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2314) +Defined in: [types/providers.ts:2324](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2324) #### total diff --git a/docs/api/type-aliases/DiagnosticResult.md b/docs/api/type-aliases/DiagnosticResult.md index c16e82426..eeadcd9cb 100644 --- a/docs/api/type-aliases/DiagnosticResult.md +++ b/docs/api/type-aliases/DiagnosticResult.md @@ -8,7 +8,7 @@ > **DiagnosticResult** = `object` -Defined in: [types/providers.ts:2301](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2301) +Defined in: [types/providers.ts:2311](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2311) Individual SageMaker diagnostic result. @@ -18,7 +18,7 @@ Individual SageMaker diagnostic result. > **name**: `string` -Defined in: [types/providers.ts:2302](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2302) +Defined in: [types/providers.ts:2312](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2312) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2302](https://github.com/juspay/neurolink/blob/r > **category**: `"configuration"` \| `"connectivity"` \| `"streaming"` -Defined in: [types/providers.ts:2303](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2303) +Defined in: [types/providers.ts:2313](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2313) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2303](https://github.com/juspay/neurolink/blob/r > **status**: `"pass"` \| `"fail"` \| `"warning"` -Defined in: [types/providers.ts:2304](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2304) +Defined in: [types/providers.ts:2314](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2314) --- @@ -42,7 +42,7 @@ Defined in: [types/providers.ts:2304](https://github.com/juspay/neurolink/blob/r > **message**: `string` -Defined in: [types/providers.ts:2305](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2305) +Defined in: [types/providers.ts:2315](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2315) --- @@ -50,7 +50,7 @@ Defined in: [types/providers.ts:2305](https://github.com/juspay/neurolink/blob/r > `optional` **details?**: `string` -Defined in: [types/providers.ts:2306](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2306) +Defined in: [types/providers.ts:2316](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2316) --- @@ -58,4 +58,4 @@ Defined in: [types/providers.ts:2306](https://github.com/juspay/neurolink/blob/r > `optional` **recommendation?**: `string` -Defined in: [types/providers.ts:2307](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2307) +Defined in: [types/providers.ts:2317](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2317) diff --git a/docs/api/type-aliases/EndpointHealth.md b/docs/api/type-aliases/EndpointHealth.md index 238654136..68a04c9c5 100644 --- a/docs/api/type-aliases/EndpointHealth.md +++ b/docs/api/type-aliases/EndpointHealth.md @@ -8,7 +8,7 @@ > **EndpointHealth** = `object` -Defined in: [types/providers.ts:2262](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2262) +Defined in: [types/providers.ts:2272](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2272) Endpoint health and metadata information. @@ -18,7 +18,7 @@ Endpoint health and metadata information. > **status**: `"healthy"` \| `"unhealthy"` \| `"unknown"` -Defined in: [types/providers.ts:2263](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2263) +Defined in: [types/providers.ts:2273](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2273) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2263](https://github.com/juspay/neurolink/blob/r > **responseTime**: `number` -Defined in: [types/providers.ts:2264](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2264) +Defined in: [types/providers.ts:2274](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2274) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2264](https://github.com/juspay/neurolink/blob/r > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:2265](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2265) +Defined in: [types/providers.ts:2275](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2275) --- @@ -42,7 +42,7 @@ Defined in: [types/providers.ts:2265](https://github.com/juspay/neurolink/blob/r > `optional` **modelInfo?**: `object` -Defined in: [types/providers.ts:2266](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2266) +Defined in: [types/providers.ts:2276](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2276) #### name? diff --git a/docs/api/type-aliases/EndpointMetrics.md b/docs/api/type-aliases/EndpointMetrics.md index db43e94de..b1caa0ecf 100644 --- a/docs/api/type-aliases/EndpointMetrics.md +++ b/docs/api/type-aliases/EndpointMetrics.md @@ -8,7 +8,7 @@ > **EndpointMetrics** = `object` -Defined in: [types/providers.ts:1777](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1777) +Defined in: [types/providers.ts:1787](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1787) Endpoint metrics and monitoring data @@ -18,7 +18,7 @@ Endpoint metrics and monitoring data > **endpointName**: `string` -Defined in: [types/providers.ts:1779](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1779) +Defined in: [types/providers.ts:1789](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1789) Endpoint name @@ -28,7 +28,7 @@ Endpoint name > **invocations**: `number` -Defined in: [types/providers.ts:1781](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1781) +Defined in: [types/providers.ts:1791](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1791) Total invocations @@ -38,7 +38,7 @@ Total invocations > **averageLatency**: `number` -Defined in: [types/providers.ts:1783](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1783) +Defined in: [types/providers.ts:1793](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1793) Average latency in milliseconds @@ -48,7 +48,7 @@ Average latency in milliseconds > **errorRate**: `number` -Defined in: [types/providers.ts:1785](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1785) +Defined in: [types/providers.ts:1795](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1795) Error rate percentage @@ -58,7 +58,7 @@ Error rate percentage > `optional` **cpuUtilization?**: `number` -Defined in: [types/providers.ts:1787](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1787) +Defined in: [types/providers.ts:1797](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1797) CPU utilization percentage @@ -68,7 +68,7 @@ CPU utilization percentage > `optional` **memoryUtilization?**: `number` -Defined in: [types/providers.ts:1789](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1789) +Defined in: [types/providers.ts:1799](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1799) Memory utilization percentage @@ -78,7 +78,7 @@ Memory utilization percentage > **instanceCount**: `number` -Defined in: [types/providers.ts:1791](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1791) +Defined in: [types/providers.ts:1801](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1801) Instance count @@ -88,6 +88,6 @@ Instance count > **timestamp**: `string` -Defined in: [types/providers.ts:1793](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1793) +Defined in: [types/providers.ts:1803](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1803) Timestamp of metrics as ISO 8601 date string diff --git a/docs/api/type-aliases/GeminiMultimodalInput.md b/docs/api/type-aliases/GeminiMultimodalInput.md index d49b90c14..587a76662 100644 --- a/docs/api/type-aliases/GeminiMultimodalInput.md +++ b/docs/api/type-aliases/GeminiMultimodalInput.md @@ -8,7 +8,7 @@ > **GeminiMultimodalInput** = `object` -Defined in: [types/providers.ts:2384](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2384) +Defined in: [types/providers.ts:2394](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2394) Subset of `GenerateOptions["input"]` consumed by the shared Gemini-native multimodal-parts builder. Kept narrow so the helper doesn't depend on the @@ -22,7 +22,7 @@ value SDK callers pass in (plain Buffer/string or `ImageWithAltText`). > `optional` **text?**: `string` -Defined in: [types/providers.ts:2385](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2385) +Defined in: [types/providers.ts:2395](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2395) --- @@ -30,7 +30,7 @@ Defined in: [types/providers.ts:2385](https://github.com/juspay/neurolink/blob/r > `optional` **pdfFiles?**: (`Buffer` \| `string`)[] -Defined in: [types/providers.ts:2386](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2386) +Defined in: [types/providers.ts:2396](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2396) --- @@ -38,7 +38,7 @@ Defined in: [types/providers.ts:2386](https://github.com/juspay/neurolink/blob/r > `optional` **images?**: (`Buffer` \| `string` \| \{ `data`: `Buffer` \| `string`; `altText?`: `string`; \})[] -Defined in: [types/providers.ts:2387](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2387) +Defined in: [types/providers.ts:2397](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2397) --- @@ -46,7 +46,7 @@ Defined in: [types/providers.ts:2387](https://github.com/juspay/neurolink/blob/r > `optional` **nativeAudioFiles?**: [`MultimodalAudioEntry`](MultimodalAudioEntry.md)[] -Defined in: [types/providers.ts:2393](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2393) +Defined in: [types/providers.ts:2403](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2403) Audio collected during file detection, carried through to the native request as `inlineData`. Distinct from the user-facing `audioFiles`: these diff --git a/docs/api/type-aliases/GoogleLiveAudioQueueItem.md b/docs/api/type-aliases/GoogleLiveAudioQueueItem.md index fddf96022..56f43ecc9 100644 --- a/docs/api/type-aliases/GoogleLiveAudioQueueItem.md +++ b/docs/api/type-aliases/GoogleLiveAudioQueueItem.md @@ -8,7 +8,7 @@ > **GoogleLiveAudioQueueItem** = \{ `type`: `"audio"`; `audio`: [`AudioChunk`](AudioChunk.md); \} \| \{ `type`: `"end"`; \} \| \{ `type`: `"error"`; `error`: `unknown`; \} -Defined in: [types/providers.ts:2344](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2344) +Defined in: [types/providers.ts:2354](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2354) Event pushed through the Google AI Studio voice session's internal queue while audio chunks stream back from the Gemini Live API. diff --git a/docs/api/type-aliases/InvokeEndpointParams.md b/docs/api/type-aliases/InvokeEndpointParams.md index 6d5b2aebf..f51db6c7c 100644 --- a/docs/api/type-aliases/InvokeEndpointParams.md +++ b/docs/api/type-aliases/InvokeEndpointParams.md @@ -91,3 +91,19 @@ Target variant for A/B testing Defined in: [types/providers.ts:1510](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1510) Inference ID for request tracking + +--- + +### abortSignal? + +> `optional` **abortSignal?**: `AbortSignal` + +Defined in: [types/providers.ts:1520](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1520) + +Cancels the in-flight HTTP request, not just the loop around it. + +Named in camelCase deliberately: every other field here mirrors an AWS +`InvokeEndpointCommandInput` member and keeps its PascalCase, whereas this +one is a transport option handed to `client.send()` as +`@smithy/types` `HttpHandlerOptions` — it is never part of the command +payload, and spelling it differently keeps that boundary visible. diff --git a/docs/api/type-aliases/InvokeEndpointResponse.md b/docs/api/type-aliases/InvokeEndpointResponse.md index 1270c93ef..1af2eadc6 100644 --- a/docs/api/type-aliases/InvokeEndpointResponse.md +++ b/docs/api/type-aliases/InvokeEndpointResponse.md @@ -8,7 +8,7 @@ > **InvokeEndpointResponse** = `object` -Defined in: [types/providers.ts:1516](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1516) +Defined in: [types/providers.ts:1526](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1526) Response from SageMaker endpoint invocation @@ -18,7 +18,7 @@ Response from SageMaker endpoint invocation > `optional` **Body?**: `Uint8Array` -Defined in: [types/providers.ts:1518](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1518) +Defined in: [types/providers.ts:1528](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1528) Response body @@ -28,7 +28,7 @@ Response body > `optional` **ContentType?**: `string` -Defined in: [types/providers.ts:1520](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1520) +Defined in: [types/providers.ts:1530](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1530) Content type of the response @@ -38,7 +38,7 @@ Content type of the response > `optional` **InvokedProductionVariant?**: `string` -Defined in: [types/providers.ts:1522](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1522) +Defined in: [types/providers.ts:1532](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1532) Invoked production variant @@ -48,6 +48,6 @@ Invoked production variant > `optional` **CustomAttributes?**: `string` -Defined in: [types/providers.ts:1524](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1524) +Defined in: [types/providers.ts:1534](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1534) Custom attributes in the response diff --git a/docs/api/type-aliases/LanguageModelObject.md b/docs/api/type-aliases/LanguageModelObject.md index b7693bee6..8dd648465 100644 --- a/docs/api/type-aliases/LanguageModelObject.md +++ b/docs/api/type-aliases/LanguageModelObject.md @@ -8,7 +8,7 @@ > **LanguageModelObject** = `object` -Defined in: [types/providers.ts:2088](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2088) +Defined in: [types/providers.ts:2098](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2098) Language model object shape (LanguageModelV2/V3). @@ -18,7 +18,7 @@ Language model object shape (LanguageModelV2/V3). > `readonly` **modelId**: `string` -Defined in: [types/providers.ts:2089](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2089) +Defined in: [types/providers.ts:2099](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2099) --- @@ -26,4 +26,4 @@ Defined in: [types/providers.ts:2089](https://github.com/juspay/neurolink/blob/r > `readonly` **provider**: `string` -Defined in: [types/providers.ts:2090](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2090) +Defined in: [types/providers.ts:2100](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2100) diff --git a/docs/api/type-aliases/ModelDeploymentConfig.md b/docs/api/type-aliases/ModelDeploymentConfig.md index f635af5ac..b6aa0cd4c 100644 --- a/docs/api/type-aliases/ModelDeploymentConfig.md +++ b/docs/api/type-aliases/ModelDeploymentConfig.md @@ -8,7 +8,7 @@ > **ModelDeploymentConfig** = `object` -Defined in: [types/providers.ts:1747](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1747) +Defined in: [types/providers.ts:1757](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1757) Model deployment configuration @@ -18,7 +18,7 @@ Model deployment configuration > **modelName**: `string` -Defined in: [types/providers.ts:1749](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1749) +Defined in: [types/providers.ts:1759](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1759) Model name @@ -28,7 +28,7 @@ Model name > **endpointName**: `string` -Defined in: [types/providers.ts:1751](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1751) +Defined in: [types/providers.ts:1761](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1761) Endpoint name @@ -38,7 +38,7 @@ Endpoint name > **instanceType**: `string` -Defined in: [types/providers.ts:1753](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1753) +Defined in: [types/providers.ts:1763](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1763) EC2 instance type @@ -48,7 +48,7 @@ EC2 instance type > **initialInstanceCount**: `number` -Defined in: [types/providers.ts:1755](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1755) +Defined in: [types/providers.ts:1765](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1765) Initial instance count @@ -58,7 +58,7 @@ Initial instance count > **modelDataUrl**: `string` -Defined in: [types/providers.ts:1757](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1757) +Defined in: [types/providers.ts:1767](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1767) Model data S3 location @@ -68,7 +68,7 @@ Model data S3 location > **image**: `string` -Defined in: [types/providers.ts:1759](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1759) +Defined in: [types/providers.ts:1769](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1769) Container image URI @@ -78,7 +78,7 @@ Container image URI > **executionRoleArn**: `string` -Defined in: [types/providers.ts:1761](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1761) +Defined in: [types/providers.ts:1771](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1771) IAM execution role ARN @@ -88,7 +88,7 @@ IAM execution role ARN > `optional` **tags?**: `Record`\<`string`, `string`\> -Defined in: [types/providers.ts:1763](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1763) +Defined in: [types/providers.ts:1773](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1773) Resource tags @@ -98,7 +98,7 @@ Resource tags > `optional` **autoScaling?**: `object` -Defined in: [types/providers.ts:1765](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1765) +Defined in: [types/providers.ts:1775](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1775) Auto scaling configuration diff --git a/docs/api/type-aliases/ModelDetectionResult.md b/docs/api/type-aliases/ModelDetectionResult.md index 942646422..a0c567083 100644 --- a/docs/api/type-aliases/ModelDetectionResult.md +++ b/docs/api/type-aliases/ModelDetectionResult.md @@ -8,7 +8,7 @@ > **ModelDetectionResult** = `object` -Defined in: [types/providers.ts:2254](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2254) +Defined in: [types/providers.ts:2264](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2264) Model type detection result. @@ -18,7 +18,7 @@ Model type detection result. > **type**: [`StreamingCapability`](StreamingCapability.md)\[`"modelType"`\] -Defined in: [types/providers.ts:2255](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2255) +Defined in: [types/providers.ts:2265](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2265) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2255](https://github.com/juspay/neurolink/blob/r > **confidence**: `number` -Defined in: [types/providers.ts:2256](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2256) +Defined in: [types/providers.ts:2266](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2266) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2256](https://github.com/juspay/neurolink/blob/r > **evidence**: `string`[] -Defined in: [types/providers.ts:2257](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2257) +Defined in: [types/providers.ts:2267](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2267) --- @@ -42,4 +42,4 @@ Defined in: [types/providers.ts:2257](https://github.com/juspay/neurolink/blob/r > `optional` **suggestedConfig?**: `Partial`\<[`SageMakerModelConfig`](SageMakerModelConfig.md)\> -Defined in: [types/providers.ts:2258](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2258) +Defined in: [types/providers.ts:2268](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2268) diff --git a/docs/api/type-aliases/NativeFunctionCall.md b/docs/api/type-aliases/NativeFunctionCall.md index c77bed71a..00e5c9066 100644 --- a/docs/api/type-aliases/NativeFunctionCall.md +++ b/docs/api/type-aliases/NativeFunctionCall.md @@ -8,7 +8,7 @@ > **NativeFunctionCall** = `object` -Defined in: [types/providers.ts:2040](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2040) +Defined in: [types/providers.ts:2050](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2050) A single function call returned by the Gemini model. @@ -18,7 +18,7 @@ A single function call returned by the Gemini model. > **name**: `string` -Defined in: [types/providers.ts:2041](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2041) +Defined in: [types/providers.ts:2051](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2051) --- @@ -26,4 +26,4 @@ Defined in: [types/providers.ts:2041](https://github.com/juspay/neurolink/blob/r > **args**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:2042](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2042) +Defined in: [types/providers.ts:2052](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2052) diff --git a/docs/api/type-aliases/NativeFunctionDeclaration.md b/docs/api/type-aliases/NativeFunctionDeclaration.md index 3b749c5d7..9fd147920 100644 --- a/docs/api/type-aliases/NativeFunctionDeclaration.md +++ b/docs/api/type-aliases/NativeFunctionDeclaration.md @@ -8,7 +8,7 @@ > **NativeFunctionDeclaration** = `object` -Defined in: [types/providers.ts:2014](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2014) +Defined in: [types/providers.ts:2024](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2024) A single function declaration for the Gemini native SDK. @@ -18,7 +18,7 @@ A single function declaration for the Gemini native SDK. > **name**: `string` -Defined in: [types/providers.ts:2015](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2015) +Defined in: [types/providers.ts:2025](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2025) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2015](https://github.com/juspay/neurolink/blob/r > **description**: `string` -Defined in: [types/providers.ts:2016](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2016) +Defined in: [types/providers.ts:2026](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2026) --- @@ -34,4 +34,4 @@ Defined in: [types/providers.ts:2016](https://github.com/juspay/neurolink/blob/r > `optional` **parametersJsonSchema?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:2017](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2017) +Defined in: [types/providers.ts:2027](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2027) diff --git a/docs/api/type-aliases/NativeFunctionResponse.md b/docs/api/type-aliases/NativeFunctionResponse.md index 76c049546..5d974653b 100644 --- a/docs/api/type-aliases/NativeFunctionResponse.md +++ b/docs/api/type-aliases/NativeFunctionResponse.md @@ -8,7 +8,7 @@ > **NativeFunctionResponse** = `object` -Defined in: [types/providers.ts:2046](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2046) +Defined in: [types/providers.ts:2056](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2056) A single function response to feed back into the conversation. @@ -18,7 +18,7 @@ A single function response to feed back into the conversation. > **functionResponse**: `object` -Defined in: [types/providers.ts:2047](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2047) +Defined in: [types/providers.ts:2057](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2057) #### name diff --git a/docs/api/type-aliases/NativeToolDeclarationsResult.md b/docs/api/type-aliases/NativeToolDeclarationsResult.md index ac86b3000..b9e232dcf 100644 --- a/docs/api/type-aliases/NativeToolDeclarationsResult.md +++ b/docs/api/type-aliases/NativeToolDeclarationsResult.md @@ -8,7 +8,7 @@ > **NativeToolDeclarationsResult** = `object` -Defined in: [types/providers.ts:2033](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2033) +Defined in: [types/providers.ts:2043](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2043) Return value of buildNativeToolDeclarations. @@ -23,7 +23,7 @@ MUST be hidden from tool-call metadata exposed to consumers. > **toolsConfig**: [`NativeToolsConfig`](NativeToolsConfig.md) -Defined in: [types/providers.ts:2034](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2034) +Defined in: [types/providers.ts:2044](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2044) --- @@ -31,7 +31,7 @@ Defined in: [types/providers.ts:2034](https://github.com/juspay/neurolink/blob/r > **executeMap**: `Map`\<`string`, `Tool`\[`"execute"`\]\> -Defined in: [types/providers.ts:2035](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2035) +Defined in: [types/providers.ts:2045](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2045) --- @@ -39,4 +39,4 @@ Defined in: [types/providers.ts:2035](https://github.com/juspay/neurolink/blob/r > **originalNameMap**: `Map`\<`string`, `string`\> -Defined in: [types/providers.ts:2036](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2036) +Defined in: [types/providers.ts:2046](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2046) diff --git a/docs/api/type-aliases/NativeToolsConfig.md b/docs/api/type-aliases/NativeToolsConfig.md index d7f6dae5f..580018b03 100644 --- a/docs/api/type-aliases/NativeToolsConfig.md +++ b/docs/api/type-aliases/NativeToolsConfig.md @@ -8,7 +8,7 @@ > **NativeToolsConfig** = `object`[] -Defined in: [types/providers.ts:2021](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2021) +Defined in: [types/providers.ts:2031](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2031) The tools config array expected by the @google/genai SDK. diff --git a/docs/api/type-aliases/NeuroLinkInstance.md b/docs/api/type-aliases/NeuroLinkInstance.md index 5ff1a3e60..7d965af54 100644 --- a/docs/api/type-aliases/NeuroLinkInstance.md +++ b/docs/api/type-aliases/NeuroLinkInstance.md @@ -8,7 +8,7 @@ > **NeuroLinkInstance** = `object` -Defined in: [types/providers.ts:2245](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2245) +Defined in: [types/providers.ts:2255](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2255) Minimal NeuroLink-like instance accepted by the image generation service. @@ -18,7 +18,7 @@ Minimal NeuroLink-like instance accepted by the image generation service. > **generate**: (`options`) => `Promise`\<`unknown`\> -Defined in: [types/providers.ts:2246](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2246) +Defined in: [types/providers.ts:2256](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2256) #### Parameters diff --git a/docs/api/type-aliases/OpenRouterModelInfo.md b/docs/api/type-aliases/OpenRouterModelInfo.md index 520204b61..5c5c875ec 100644 --- a/docs/api/type-aliases/OpenRouterModelInfo.md +++ b/docs/api/type-aliases/OpenRouterModelInfo.md @@ -8,7 +8,7 @@ > **OpenRouterModelInfo** = `object` -Defined in: [types/providers.ts:1974](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1974) +Defined in: [types/providers.ts:1984](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1984) OpenRouter model information from /api/v1/models endpoint @@ -18,7 +18,7 @@ OpenRouter model information from /api/v1/models endpoint > **id**: `string` -Defined in: [types/providers.ts:1976](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1976) +Defined in: [types/providers.ts:1986](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1986) Model ID in format 'provider/model-name' @@ -28,7 +28,7 @@ Model ID in format 'provider/model-name' > `optional` **supported_parameters?**: `string`[] -Defined in: [types/providers.ts:1978](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1978) +Defined in: [types/providers.ts:1988](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1988) Supported parameters (e.g., 'tools', 'temperature') @@ -38,7 +38,7 @@ Supported parameters (e.g., 'tools', 'temperature') > `optional` **name?**: `string` -Defined in: [types/providers.ts:1980](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1980) +Defined in: [types/providers.ts:1990](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1990) Model name @@ -48,7 +48,7 @@ Model name > `optional` **description?**: `string` -Defined in: [types/providers.ts:1982](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1982) +Defined in: [types/providers.ts:1992](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1992) Model description @@ -58,7 +58,7 @@ Model description > `optional` **pricing?**: `object` -Defined in: [types/providers.ts:1984](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1984) +Defined in: [types/providers.ts:1994](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1994) Pricing information @@ -76,6 +76,6 @@ Pricing information > `optional` **context_length?**: `number` -Defined in: [types/providers.ts:1989](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1989) +Defined in: [types/providers.ts:1999](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1999) Context length diff --git a/docs/api/type-aliases/OpenRouterModelsResponse.md b/docs/api/type-aliases/OpenRouterModelsResponse.md index 4243438b9..676725628 100644 --- a/docs/api/type-aliases/OpenRouterModelsResponse.md +++ b/docs/api/type-aliases/OpenRouterModelsResponse.md @@ -8,7 +8,7 @@ > **OpenRouterModelsResponse** = `object` -Defined in: [types/providers.ts:1995](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1995) +Defined in: [types/providers.ts:2005](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2005) OpenRouter models API response @@ -18,4 +18,4 @@ OpenRouter models API response > **data**: [`OpenRouterModelInfo`](OpenRouterModelInfo.md)[] -Defined in: [types/providers.ts:1996](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1996) +Defined in: [types/providers.ts:2006](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2006) diff --git a/docs/api/type-aliases/OpenRouterProviderCache.md b/docs/api/type-aliases/OpenRouterProviderCache.md index b0b07f3dd..947ce132a 100644 --- a/docs/api/type-aliases/OpenRouterProviderCache.md +++ b/docs/api/type-aliases/OpenRouterProviderCache.md @@ -8,7 +8,7 @@ > **OpenRouterProviderCache** = `object` -Defined in: [types/providers.ts:2002](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2002) +Defined in: [types/providers.ts:2012](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2012) OpenRouter provider static cache properties (for testing/internal use) @@ -18,7 +18,7 @@ OpenRouter provider static cache properties (for testing/internal use) > **modelsCache**: `string`[] -Defined in: [types/providers.ts:2003](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2003) +Defined in: [types/providers.ts:2013](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2013) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2003](https://github.com/juspay/neurolink/blob/r > **modelsCacheTime**: `number` -Defined in: [types/providers.ts:2004](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2004) +Defined in: [types/providers.ts:2014](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2014) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2004](https://github.com/juspay/neurolink/blob/r > **toolCapableModels**: `Set`\<`string`\> -Defined in: [types/providers.ts:2005](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2005) +Defined in: [types/providers.ts:2015](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2015) --- @@ -42,4 +42,4 @@ Defined in: [types/providers.ts:2005](https://github.com/juspay/neurolink/blob/r > **capabilitiesCached**: `boolean` -Defined in: [types/providers.ts:2006](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2006) +Defined in: [types/providers.ts:2016](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2016) diff --git a/docs/api/type-aliases/ParallelDetectionConfig.md b/docs/api/type-aliases/ParallelDetectionConfig.md index b4b1f0667..df1b9e9ab 100644 --- a/docs/api/type-aliases/ParallelDetectionConfig.md +++ b/docs/api/type-aliases/ParallelDetectionConfig.md @@ -8,7 +8,7 @@ > **ParallelDetectionConfig** = `object` -Defined in: [types/providers.ts:2290](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2290) +Defined in: [types/providers.ts:2300](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2300) Configuration object for parallel detection test execution. @@ -18,7 +18,7 @@ Configuration object for parallel detection test execution. > **maxConcurrentTests**: `number` -Defined in: [types/providers.ts:2291](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2291) +Defined in: [types/providers.ts:2301](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2301) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2291](https://github.com/juspay/neurolink/blob/r > **maxRateLimitRetries**: `number` -Defined in: [types/providers.ts:2292](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2292) +Defined in: [types/providers.ts:2302](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2302) --- @@ -34,4 +34,4 @@ Defined in: [types/providers.ts:2292](https://github.com/juspay/neurolink/blob/r > **initialRateLimitCount**: `number` -Defined in: [types/providers.ts:2293](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2293) +Defined in: [types/providers.ts:2303](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2303) diff --git a/docs/api/type-aliases/ProviderConstructor.md b/docs/api/type-aliases/ProviderConstructor.md index 0f9b825c9..1b12ad0a0 100644 --- a/docs/api/type-aliases/ProviderConstructor.md +++ b/docs/api/type-aliases/ProviderConstructor.md @@ -8,7 +8,7 @@ > **ProviderConstructor** = ((`modelName?`, `providerName?`, `sdk?`, `region?`, `credentials?`) => [`AIProvider`](AIProvider.md)) \| ((`modelName?`, `providerName?`, `sdk?`, `region?`, `credentials?`) => `Promise`\<[`AIProvider`](AIProvider.md)\>) -Defined in: [types/providers.ts:2123](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2123) +Defined in: [types/providers.ts:2133](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2133) Provider constructor interface - supports both sync constructors and async factory functions. diff --git a/docs/api/type-aliases/ProviderDescriptor.md b/docs/api/type-aliases/ProviderDescriptor.md index f3aa49ab8..dabb705e8 100644 --- a/docs/api/type-aliases/ProviderDescriptor.md +++ b/docs/api/type-aliases/ProviderDescriptor.md @@ -8,7 +8,7 @@ > **ProviderDescriptor** = `object` -Defined in: [types/providers.ts:2159](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2159) +Defined in: [types/providers.ts:2169](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2169) Single source of truth for one AI provider's static identity: how it's addressed (name/aliases), how it's authenticated (credentialsKey/envVars), @@ -25,7 +25,7 @@ instead. See src/lib/factories/providerDescriptors.ts for the data. > **name**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:2161](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2161) +Defined in: [types/providers.ts:2171](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2171) Canonical identity — matches an AIProviderName enum member (never AUTO). @@ -35,7 +35,7 @@ Canonical identity — matches an AIProviderName enum member (never AUTO). > **aliases**: readonly `string`[] -Defined in: [types/providers.ts:2163](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2163) +Defined in: [types/providers.ts:2173](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2173) Alternate spellings accepted by the CLI and the alias index (kebab-case, shorthand, legacy names). Does not include `name` itself. @@ -45,7 +45,7 @@ Alternate spellings accepted by the CLI and the alias index (kebab-case, shortha > **credentialsKey**: keyof [`NeurolinkCredentials`](NeurolinkCredentials.md) -Defined in: [types/providers.ts:2165](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2165) +Defined in: [types/providers.ts:2175](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2175) Key into NeurolinkCredentials for per-call/per-instance credential overrides. @@ -55,7 +55,7 @@ Key into NeurolinkCredentials for per-call/per-instance credential overrides. > **envVars**: `object` -Defined in: [types/providers.ts:2167](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2167) +Defined in: [types/providers.ts:2177](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2177) Environment variables this provider reads at runtime. @@ -117,7 +117,7 @@ True when the provider is usable with zero configuration (local runtime with a d > **defaultModel**: `string` -Defined in: [types/providers.ts:2193](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2193) +Defined in: [types/providers.ts:2203](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2203) Static fallback model. The empty string "" is a documented sentinel meaning "no static default — resolved at runtime via envVars.model or @@ -131,7 +131,7 @@ LM Studio, llama.cpp, matching how providerRegistry.ts already passes > **toolSupport**: `"native"` \| `"prompt-only"` \| `"none"` \| `"model-dependent"` -Defined in: [types/providers.ts:2194](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2194) +Defined in: [types/providers.ts:2204](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2204) --- @@ -139,7 +139,7 @@ Defined in: [types/providers.ts:2194](https://github.com/juspay/neurolink/blob/r > **localRuntime**: `boolean` -Defined in: [types/providers.ts:2196](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2196) +Defined in: [types/providers.ts:2206](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2206) True only for providers that run entirely on the caller's machine with no cloud account (Ollama, LM Studio, llama.cpp). LiteLLM is a local proxy but commonly points at cloud models, so it is deliberately false. @@ -149,7 +149,7 @@ True only for providers that run entirely on the caller's machine with no cloud > **healthCheck**: `"env-only"` \| `"models-probe"` \| `"live-generate"` -Defined in: [types/providers.ts:2198](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2198) +Defined in: [types/providers.ts:2208](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2208) How ProviderHealthChecker should verify this provider is reachable. @@ -159,7 +159,7 @@ How ProviderHealthChecker should verify this provider is reachable. > `optional` **defaultHealthSweepPriority?**: `number` -Defined in: [types/providers.ts:2207](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2207) +Defined in: [types/providers.ts:2217](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2217) Membership + order in the default health sweep (`ProviderHealthChecker.checkAllProvidersHealth` with no explicit @@ -174,7 +174,7 @@ array that lived in providerHealth.ts. > `optional` **autoSelectPreference?**: `number` -Defined in: [types/providers.ts:2216](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2216) +Defined in: [types/providers.ts:2226](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2226) Preference rank for `getBestHealthyProvider`'s default auto-selection (lower = tried first). Deliberately a SEPARATE ordering from the sweep: @@ -189,7 +189,7 @@ that lived inline as getBestHealthyProvider's default parameter. > `optional` **setupUrl?**: `string` -Defined in: [types/providers.ts:2217](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2217) +Defined in: [types/providers.ts:2227](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2227) --- @@ -197,7 +197,7 @@ Defined in: [types/providers.ts:2217](https://github.com/juspay/neurolink/blob/r > `optional` **timeouts?**: `object` -Defined in: [types/providers.ts:2218](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2218) +Defined in: [types/providers.ts:2228](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2228) #### generateMs? @@ -213,7 +213,7 @@ Defined in: [types/providers.ts:2218](https://github.com/juspay/neurolink/blob/r > `optional` **autoSelectPriority?**: `number` -Defined in: [types/providers.ts:2220](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2220) +Defined in: [types/providers.ts:2230](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2230) Ascending priority (1 = tried first) in the auto-select fallback chain used by getBestProvider(). Undefined = not part of the auto-select chain. @@ -223,7 +223,7 @@ Ascending priority (1 = tried first) in the auto-select fallback chain used by g > `optional` **apiKeyFormatPattern?**: `RegExp` -Defined in: [types/providers.ts:2222](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2222) +Defined in: [types/providers.ts:2232](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2232) Format-validation regex sourced from providerConfig.ts's API_KEY_FORMATS, when one exists for this provider. @@ -233,7 +233,7 @@ Format-validation regex sourced from providerConfig.ts's API_KEY_FORMATS, when o > `optional` **credentialsResolvedExternally?**: `boolean` -Defined in: [types/providers.ts:2237](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2237) +Defined in: [types/providers.ts:2247](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2247) True when this provider's credentials are resolved by an external chain or its own config validator rather than by plain env-var presence, so diff --git a/docs/api/type-aliases/ProviderHealthCheckOptions.md b/docs/api/type-aliases/ProviderHealthCheckOptions.md index 0391e5660..0fa1e9038 100644 --- a/docs/api/type-aliases/ProviderHealthCheckOptions.md +++ b/docs/api/type-aliases/ProviderHealthCheckOptions.md @@ -8,7 +8,7 @@ > **ProviderHealthCheckOptions** = `object` -Defined in: [types/providers.ts:1891](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1891) +Defined in: [types/providers.ts:1901](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1901) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1891](https://github.com/juspay/neurolink/blob/r > `optional` **timeout?**: `number` -Defined in: [types/providers.ts:1892](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1892) +Defined in: [types/providers.ts:1902](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1902) --- @@ -24,7 +24,7 @@ Defined in: [types/providers.ts:1892](https://github.com/juspay/neurolink/blob/r > `optional` **includeConnectivityTest?**: `boolean` -Defined in: [types/providers.ts:1893](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1893) +Defined in: [types/providers.ts:1903](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1903) --- @@ -32,7 +32,7 @@ Defined in: [types/providers.ts:1893](https://github.com/juspay/neurolink/blob/r > `optional` **includeModelValidation?**: `boolean` -Defined in: [types/providers.ts:1894](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1894) +Defined in: [types/providers.ts:1904](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1904) --- @@ -40,7 +40,7 @@ Defined in: [types/providers.ts:1894](https://github.com/juspay/neurolink/blob/r > `optional` **cacheResults?**: `boolean` -Defined in: [types/providers.ts:1895](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1895) +Defined in: [types/providers.ts:1905](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1905) --- @@ -48,4 +48,4 @@ Defined in: [types/providers.ts:1895](https://github.com/juspay/neurolink/blob/r > `optional` **maxCacheAge?**: `number` -Defined in: [types/providers.ts:1896](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1896) +Defined in: [types/providers.ts:1906](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1906) diff --git a/docs/api/type-aliases/ProviderHealthStatusOptions.md b/docs/api/type-aliases/ProviderHealthStatusOptions.md index a2d76f3d1..4915ae499 100644 --- a/docs/api/type-aliases/ProviderHealthStatusOptions.md +++ b/docs/api/type-aliases/ProviderHealthStatusOptions.md @@ -8,7 +8,7 @@ > **ProviderHealthStatusOptions** = `object` -Defined in: [types/providers.ts:1857](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1857) +Defined in: [types/providers.ts:1867](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1867) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:1857](https://github.com/juspay/neurolink/blob/r > **provider**: [`AIProviderName`](../enumerations/AIProviderName.md) -Defined in: [types/providers.ts:1858](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1858) +Defined in: [types/providers.ts:1868](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1868) --- @@ -24,7 +24,7 @@ Defined in: [types/providers.ts:1858](https://github.com/juspay/neurolink/blob/r > **isHealthy**: `boolean` -Defined in: [types/providers.ts:1859](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1859) +Defined in: [types/providers.ts:1869](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1869) --- @@ -32,7 +32,7 @@ Defined in: [types/providers.ts:1859](https://github.com/juspay/neurolink/blob/r > **isConfigured**: `boolean` -Defined in: [types/providers.ts:1860](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1860) +Defined in: [types/providers.ts:1870](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1870) --- @@ -40,7 +40,7 @@ Defined in: [types/providers.ts:1860](https://github.com/juspay/neurolink/blob/r > **hasApiKey**: `boolean` -Defined in: [types/providers.ts:1861](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1861) +Defined in: [types/providers.ts:1871](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1871) --- @@ -48,7 +48,7 @@ Defined in: [types/providers.ts:1861](https://github.com/juspay/neurolink/blob/r > **lastChecked**: `Date` -Defined in: [types/providers.ts:1862](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1862) +Defined in: [types/providers.ts:1872](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1872) --- @@ -56,7 +56,7 @@ Defined in: [types/providers.ts:1862](https://github.com/juspay/neurolink/blob/r > `optional` **error?**: `string` -Defined in: [types/providers.ts:1863](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1863) +Defined in: [types/providers.ts:1873](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1873) --- @@ -64,7 +64,7 @@ Defined in: [types/providers.ts:1863](https://github.com/juspay/neurolink/blob/r > `optional` **warning?**: `string` -Defined in: [types/providers.ts:1864](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1864) +Defined in: [types/providers.ts:1874](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1874) --- @@ -72,7 +72,7 @@ Defined in: [types/providers.ts:1864](https://github.com/juspay/neurolink/blob/r > `optional` **responseTime?**: `number` -Defined in: [types/providers.ts:1865](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1865) +Defined in: [types/providers.ts:1875](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1875) --- @@ -80,7 +80,7 @@ Defined in: [types/providers.ts:1865](https://github.com/juspay/neurolink/blob/r > **configurationIssues**: `string`[] -Defined in: [types/providers.ts:1866](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1866) +Defined in: [types/providers.ts:1876](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1876) --- @@ -88,4 +88,4 @@ Defined in: [types/providers.ts:1866](https://github.com/juspay/neurolink/blob/r > **recommendations**: `string`[] -Defined in: [types/providers.ts:1867](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1867) +Defined in: [types/providers.ts:1877](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1877) diff --git a/docs/api/type-aliases/ProviderRegistration.md b/docs/api/type-aliases/ProviderRegistration.md index d098ee74b..fe5e198f0 100644 --- a/docs/api/type-aliases/ProviderRegistration.md +++ b/docs/api/type-aliases/ProviderRegistration.md @@ -8,7 +8,7 @@ > **ProviderRegistration** = `object` -Defined in: [types/providers.ts:2142](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2142) +Defined in: [types/providers.ts:2152](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2152) Provider registration entry held by ProviderFactory. @@ -18,7 +18,7 @@ Provider registration entry held by ProviderFactory. > **constructor**: [`ProviderConstructor`](ProviderConstructor.md) -Defined in: [types/providers.ts:2143](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2143) +Defined in: [types/providers.ts:2153](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2153) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2143](https://github.com/juspay/neurolink/blob/r > `optional` **defaultModel?**: `string` -Defined in: [types/providers.ts:2144](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2144) +Defined in: [types/providers.ts:2154](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2154) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2144](https://github.com/juspay/neurolink/blob/r > `optional` **aliases?**: `string`[] -Defined in: [types/providers.ts:2145](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2145) +Defined in: [types/providers.ts:2155](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2155) --- @@ -42,4 +42,4 @@ Defined in: [types/providers.ts:2145](https://github.com/juspay/neurolink/blob/r > `optional` **descriptor?**: [`ProviderDescriptor`](ProviderDescriptor.md) -Defined in: [types/providers.ts:2146](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2146) +Defined in: [types/providers.ts:2156](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2156) diff --git a/docs/api/type-aliases/SageMakerAsLanguageModel.md b/docs/api/type-aliases/SageMakerAsLanguageModel.md index 1e3a1e87c..990c9d59a 100644 --- a/docs/api/type-aliases/SageMakerAsLanguageModel.md +++ b/docs/api/type-aliases/SageMakerAsLanguageModel.md @@ -8,7 +8,7 @@ > **SageMakerAsLanguageModel** = `object` -Defined in: [types/providers.ts:1882](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1882) +Defined in: [types/providers.ts:1892](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1892) Structural type that captures what AI SDK's `streamText` / `generateText` actually invoke at runtime on a model object. @@ -23,7 +23,7 @@ intermediate type, avoiding `as unknown as LanguageModel`. > `readonly` **specificationVersion**: `string` -Defined in: [types/providers.ts:1883](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1883) +Defined in: [types/providers.ts:1893](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1893) --- @@ -31,7 +31,7 @@ Defined in: [types/providers.ts:1883](https://github.com/juspay/neurolink/blob/r > `readonly` **provider**: `string` -Defined in: [types/providers.ts:1884](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1884) +Defined in: [types/providers.ts:1894](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1894) --- @@ -39,7 +39,7 @@ Defined in: [types/providers.ts:1884](https://github.com/juspay/neurolink/blob/r > `readonly` **modelId**: `string` -Defined in: [types/providers.ts:1885](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1885) +Defined in: [types/providers.ts:1895](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1895) --- @@ -47,7 +47,7 @@ Defined in: [types/providers.ts:1885](https://github.com/juspay/neurolink/blob/r > `readonly` **supportedUrls**: `Record`\<`string`, `RegExp`[]\> -Defined in: [types/providers.ts:1886](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1886) +Defined in: [types/providers.ts:1896](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1896) ## Methods @@ -55,7 +55,7 @@ Defined in: [types/providers.ts:1886](https://github.com/juspay/neurolink/blob/r > **doGenerate**(`options`): `Promise`\<`unknown`\> -Defined in: [types/providers.ts:1887](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1887) +Defined in: [types/providers.ts:1897](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1897) #### Parameters @@ -73,7 +73,7 @@ Defined in: [types/providers.ts:1887](https://github.com/juspay/neurolink/blob/r > **doStream**(`options`): `Promise`\<`unknown`\> -Defined in: [types/providers.ts:1888](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1888) +Defined in: [types/providers.ts:1898](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1898) #### Parameters diff --git a/docs/api/type-aliases/SageMakerErrorCode.md b/docs/api/type-aliases/SageMakerErrorCode.md index bb22b9f45..2dd83e1ca 100644 --- a/docs/api/type-aliases/SageMakerErrorCode.md +++ b/docs/api/type-aliases/SageMakerErrorCode.md @@ -8,6 +8,6 @@ > **SageMakerErrorCode** = `"VALIDATION_ERROR"` \| `"MODEL_ERROR"` \| `"INTERNAL_ERROR"` \| `"SERVICE_UNAVAILABLE"` \| `"CREDENTIALS_ERROR"` \| `"NETWORK_ERROR"` \| `"ENDPOINT_NOT_FOUND"` \| `"THROTTLING_ERROR"` \| `"UNKNOWN_ERROR"` -Defined in: [types/providers.ts:1693](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1693) +Defined in: [types/providers.ts:1703](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1703) Error codes specific to SageMaker operations diff --git a/docs/api/type-aliases/SageMakerErrorInfo.md b/docs/api/type-aliases/SageMakerErrorInfo.md index f766152bf..bebfc86f8 100644 --- a/docs/api/type-aliases/SageMakerErrorInfo.md +++ b/docs/api/type-aliases/SageMakerErrorInfo.md @@ -8,7 +8,7 @@ > **SageMakerErrorInfo** = `object` -Defined in: [types/providers.ts:1707](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1707) +Defined in: [types/providers.ts:1717](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1717) SageMaker-specific error information @@ -18,7 +18,7 @@ SageMaker-specific error information > **code**: [`SageMakerErrorCode`](SageMakerErrorCode.md) -Defined in: [types/providers.ts:1709](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1709) +Defined in: [types/providers.ts:1719](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1719) Error code @@ -28,7 +28,7 @@ Error code > **message**: `string` -Defined in: [types/providers.ts:1711](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1711) +Defined in: [types/providers.ts:1721](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1721) Human-readable error message @@ -38,7 +38,7 @@ Human-readable error message > `optional` **statusCode?**: `number` -Defined in: [types/providers.ts:1713](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1713) +Defined in: [types/providers.ts:1723](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1723) HTTP status code if applicable @@ -48,7 +48,7 @@ HTTP status code if applicable > `optional` **cause?**: `Error` -Defined in: [types/providers.ts:1715](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1715) +Defined in: [types/providers.ts:1725](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1725) Original error from AWS SDK @@ -58,7 +58,7 @@ Original error from AWS SDK > `optional` **endpoint?**: `string` -Defined in: [types/providers.ts:1717](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1717) +Defined in: [types/providers.ts:1727](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1727) Endpoint name where error occurred @@ -68,7 +68,7 @@ Endpoint name where error occurred > `optional` **requestId?**: `string` -Defined in: [types/providers.ts:1719](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1719) +Defined in: [types/providers.ts:1729](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1729) Request ID for debugging @@ -78,6 +78,6 @@ Request ID for debugging > `optional` **retryable?**: `boolean` -Defined in: [types/providers.ts:1721](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1721) +Defined in: [types/providers.ts:1731](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1731) Retry suggestion diff --git a/docs/api/type-aliases/SageMakerGenerateResult.md b/docs/api/type-aliases/SageMakerGenerateResult.md index eb50f7120..6998cdbfd 100644 --- a/docs/api/type-aliases/SageMakerGenerateResult.md +++ b/docs/api/type-aliases/SageMakerGenerateResult.md @@ -8,7 +8,7 @@ > **SageMakerGenerateResult** = `object` -Defined in: [types/providers.ts:1823](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1823) +Defined in: [types/providers.ts:1833](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1833) SageMaker generation result type for better type safety @@ -18,7 +18,7 @@ SageMaker generation result type for better type safety > `optional` **text?**: `string` -Defined in: [types/providers.ts:1824](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1824) +Defined in: [types/providers.ts:1834](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1834) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:1824](https://github.com/juspay/neurolink/blob/r > `optional` **reasoning?**: `string` \| (\{ `type`: `"text"`; `text`: `string`; `signature?`: `string`; \} \| \{ `type`: `"redacted"`; `data`: `string`; \})[] -Defined in: [types/providers.ts:1825](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1825) +Defined in: [types/providers.ts:1835](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1835) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:1825](https://github.com/juspay/neurolink/blob/r > `optional` **files?**: `object`[] -Defined in: [types/providers.ts:1831](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1831) +Defined in: [types/providers.ts:1841](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1841) #### data @@ -50,7 +50,7 @@ Defined in: [types/providers.ts:1831](https://github.com/juspay/neurolink/blob/r > `optional` **logprobs?**: `object`[] -Defined in: [types/providers.ts:1832](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1832) +Defined in: [types/providers.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1842) #### token @@ -70,7 +70,7 @@ Defined in: [types/providers.ts:1832](https://github.com/juspay/neurolink/blob/r > **usage**: `object` -Defined in: [types/providers.ts:1837](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1837) +Defined in: [types/providers.ts:1847](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1847) #### promptTokens @@ -90,7 +90,7 @@ Defined in: [types/providers.ts:1837](https://github.com/juspay/neurolink/blob/r > **finishReason**: `"stop"` \| `"length"` \| `"content-filter"` \| `"tool-calls"` \| `"error"` \| `"unknown"` -Defined in: [types/providers.ts:1842](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1842) +Defined in: [types/providers.ts:1852](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1852) --- @@ -98,7 +98,7 @@ Defined in: [types/providers.ts:1842](https://github.com/juspay/neurolink/blob/r > `optional` **warnings?**: `object`[] -Defined in: [types/providers.ts:1849](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1849) +Defined in: [types/providers.ts:1859](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1859) #### type @@ -114,7 +114,7 @@ Defined in: [types/providers.ts:1849](https://github.com/juspay/neurolink/blob/r > **rawCall**: `object` -Defined in: [types/providers.ts:1850](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1850) +Defined in: [types/providers.ts:1860](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1860) #### rawPrompt @@ -130,7 +130,7 @@ Defined in: [types/providers.ts:1850](https://github.com/juspay/neurolink/blob/r > `optional` **rawResponse?**: `object` -Defined in: [types/providers.ts:1851](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1851) +Defined in: [types/providers.ts:1861](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1861) #### headers? @@ -142,7 +142,7 @@ Defined in: [types/providers.ts:1851](https://github.com/juspay/neurolink/blob/r > `optional` **request?**: `object` -Defined in: [types/providers.ts:1852](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1852) +Defined in: [types/providers.ts:1862](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1862) #### body? @@ -154,7 +154,7 @@ Defined in: [types/providers.ts:1852](https://github.com/juspay/neurolink/blob/r > `optional` **toolCalls?**: [`SageMakerToolCall`](SageMakerToolCall.md)[] -Defined in: [types/providers.ts:1853](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1853) +Defined in: [types/providers.ts:1863](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1863) --- @@ -162,4 +162,4 @@ Defined in: [types/providers.ts:1853](https://github.com/juspay/neurolink/blob/r > `optional` **object?**: `unknown` -Defined in: [types/providers.ts:1854](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1854) +Defined in: [types/providers.ts:1864](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1864) diff --git a/docs/api/type-aliases/SageMakerGenerationOptions.md b/docs/api/type-aliases/SageMakerGenerationOptions.md index 59b39bf17..b4add03b1 100644 --- a/docs/api/type-aliases/SageMakerGenerationOptions.md +++ b/docs/api/type-aliases/SageMakerGenerationOptions.md @@ -8,7 +8,7 @@ > **SageMakerGenerationOptions** = `object` -Defined in: [types/providers.ts:1643](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1643) +Defined in: [types/providers.ts:1653](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1653) Enhanced generation request options @@ -18,7 +18,7 @@ Enhanced generation request options > **prompt**: `string` -Defined in: [types/providers.ts:1645](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1645) +Defined in: [types/providers.ts:1655](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1655) Input prompt text @@ -28,7 +28,7 @@ Input prompt text > `optional` **systemPrompt?**: `string` -Defined in: [types/providers.ts:1647](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1647) +Defined in: [types/providers.ts:1657](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1657) System prompt for context @@ -38,7 +38,7 @@ System prompt for context > `optional` **maxTokens?**: `number` -Defined in: [types/providers.ts:1649](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1649) +Defined in: [types/providers.ts:1659](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1659) Maximum tokens to generate @@ -48,7 +48,7 @@ Maximum tokens to generate > `optional` **temperature?**: `number` -Defined in: [types/providers.ts:1651](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1651) +Defined in: [types/providers.ts:1661](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1661) Temperature for randomness (0-1) @@ -58,7 +58,7 @@ Temperature for randomness (0-1) > `optional` **topP?**: `number` -Defined in: [types/providers.ts:1653](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1653) +Defined in: [types/providers.ts:1663](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1663) Top-p nucleus sampling (0-1) @@ -68,7 +68,7 @@ Top-p nucleus sampling (0-1) > `optional` **topK?**: `number` -Defined in: [types/providers.ts:1655](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1655) +Defined in: [types/providers.ts:1665](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1665) Top-k sampling @@ -78,7 +78,7 @@ Top-k sampling > `optional` **stopSequences?**: `string`[] -Defined in: [types/providers.ts:1657](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1657) +Defined in: [types/providers.ts:1667](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1667) Stop sequences to end generation @@ -88,7 +88,7 @@ Stop sequences to end generation > `optional` **stream?**: `boolean` -Defined in: [types/providers.ts:1659](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1659) +Defined in: [types/providers.ts:1669](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1669) Enable streaming response @@ -98,7 +98,7 @@ Enable streaming response > `optional` **tools?**: `object`[] -Defined in: [types/providers.ts:1661](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1661) +Defined in: [types/providers.ts:1671](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1671) Tools available for function calling @@ -120,6 +120,6 @@ Tools available for function calling > `optional` **toolChoice?**: `"auto"` \| `"none"` \| \{ `type`: `"tool"`; `name`: `string`; \} -Defined in: [types/providers.ts:1667](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1667) +Defined in: [types/providers.ts:1677](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1677) Tool choice mode diff --git a/docs/api/type-aliases/SageMakerGenerationResponse.md b/docs/api/type-aliases/SageMakerGenerationResponse.md index 38dede371..8c6b73fc3 100644 --- a/docs/api/type-aliases/SageMakerGenerationResponse.md +++ b/docs/api/type-aliases/SageMakerGenerationResponse.md @@ -8,7 +8,7 @@ > **SageMakerGenerationResponse** = `object` -Defined in: [types/providers.ts:1673](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1673) +Defined in: [types/providers.ts:1683](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1683) Generation response from SageMaker @@ -18,7 +18,7 @@ Generation response from SageMaker > **text**: `string` -Defined in: [types/providers.ts:1675](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1675) +Defined in: [types/providers.ts:1685](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1685) Generated text content @@ -28,7 +28,7 @@ Generated text content > **usage**: [`SageMakerUsage`](SageMakerUsage.md) -Defined in: [types/providers.ts:1677](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1677) +Defined in: [types/providers.ts:1687](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1687) Token usage information @@ -38,7 +38,7 @@ Token usage information > **finishReason**: `"stop"` \| `"length"` \| `"tool-calls"` \| `"content-filter"` \| `"unknown"` -Defined in: [types/providers.ts:1679](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1679) +Defined in: [types/providers.ts:1689](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1689) Finish reason for generation @@ -48,7 +48,7 @@ Finish reason for generation > `optional` **toolCalls?**: [`SageMakerToolCall`](SageMakerToolCall.md)[] -Defined in: [types/providers.ts:1681](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1681) +Defined in: [types/providers.ts:1691](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1691) Tool calls made during generation @@ -58,7 +58,7 @@ Tool calls made during generation > `optional` **toolResults?**: [`SageMakerToolResult`](SageMakerToolResult.md)[] -Defined in: [types/providers.ts:1683](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1683) +Defined in: [types/providers.ts:1693](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1693) Tool results if tools were executed @@ -68,7 +68,7 @@ Tool results if tools were executed > `optional` **metadata?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:1685](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1685) +Defined in: [types/providers.ts:1695](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1695) Additional metadata @@ -78,6 +78,6 @@ Additional metadata > `optional` **modelVersion?**: `string` -Defined in: [types/providers.ts:1687](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1687) +Defined in: [types/providers.ts:1697](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1697) Model version or identifier diff --git a/docs/api/type-aliases/SageMakerOpenAIToolCall.md b/docs/api/type-aliases/SageMakerOpenAIToolCall.md index 87e97ac1e..71447e08e 100644 --- a/docs/api/type-aliases/SageMakerOpenAIToolCall.md +++ b/docs/api/type-aliases/SageMakerOpenAIToolCall.md @@ -8,7 +8,7 @@ > **SageMakerOpenAIToolCall** = `object` -Defined in: [types/providers.ts:2327](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2327) +Defined in: [types/providers.ts:2337](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2337) SageMaker tool_call item in the OpenAI-compatible payload shape. @@ -18,7 +18,7 @@ SageMaker tool_call item in the OpenAI-compatible payload shape. > **type**: `"function"` -Defined in: [types/providers.ts:2328](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2328) +Defined in: [types/providers.ts:2338](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2338) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2328](https://github.com/juspay/neurolink/blob/r > **id**: `string` -Defined in: [types/providers.ts:2329](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2329) +Defined in: [types/providers.ts:2339](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2339) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2329](https://github.com/juspay/neurolink/blob/r > **function**: `object` -Defined in: [types/providers.ts:2330](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2330) +Defined in: [types/providers.ts:2340](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2340) #### name diff --git a/docs/api/type-aliases/SageMakerStreamChunk.md b/docs/api/type-aliases/SageMakerStreamChunk.md index 22aa81cfa..2ad429bce 100644 --- a/docs/api/type-aliases/SageMakerStreamChunk.md +++ b/docs/api/type-aliases/SageMakerStreamChunk.md @@ -8,7 +8,7 @@ > **SageMakerStreamChunk** = `object` -Defined in: [types/providers.ts:1530](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1530) +Defined in: [types/providers.ts:1540](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1540) Streaming response chunk from SageMaker @@ -18,7 +18,7 @@ Streaming response chunk from SageMaker > `optional` **content?**: `string` -Defined in: [types/providers.ts:1532](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1532) +Defined in: [types/providers.ts:1542](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1542) Text content in the chunk @@ -28,7 +28,7 @@ Text content in the chunk > `optional` **done?**: `boolean` -Defined in: [types/providers.ts:1534](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1534) +Defined in: [types/providers.ts:1544](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1544) Indicates if this is the final chunk @@ -38,7 +38,7 @@ Indicates if this is the final chunk > `optional` **usage?**: [`SageMakerUsage`](SageMakerUsage.md) -Defined in: [types/providers.ts:1536](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1536) +Defined in: [types/providers.ts:1546](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1546) Usage information (only in final chunk) @@ -48,7 +48,7 @@ Usage information (only in final chunk) > `optional` **error?**: `string` -Defined in: [types/providers.ts:1538](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1538) +Defined in: [types/providers.ts:1548](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1548) Error information if chunk contains error @@ -58,7 +58,7 @@ Error information if chunk contains error > `optional` **finishReason?**: `"stop"` \| `"length"` \| `"tool-calls"` \| `"content-filter"` \| `"unknown"` -Defined in: [types/providers.ts:1540](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1540) +Defined in: [types/providers.ts:1550](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1550) Finish reason for generation @@ -68,7 +68,7 @@ Finish reason for generation > `optional` **toolCall?**: [`SageMakerStreamingToolCall`](SageMakerStreamingToolCall.md) -Defined in: [types/providers.ts:1547](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1547) +Defined in: [types/providers.ts:1557](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1557) Tool call in progress (Phase 2.3) @@ -78,7 +78,7 @@ Tool call in progress (Phase 2.3) > `optional` **toolResult?**: [`SageMakerStreamingToolResult`](SageMakerStreamingToolResult.md) -Defined in: [types/providers.ts:1549](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1549) +Defined in: [types/providers.ts:1559](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1559) Tool result chunk (Phase 2.3) @@ -88,6 +88,6 @@ Tool result chunk (Phase 2.3) > `optional` **structuredOutput?**: [`SageMakerStructuredOutput`](SageMakerStructuredOutput.md) -Defined in: [types/providers.ts:1551](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1551) +Defined in: [types/providers.ts:1561](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1561) Structured output streaming (Phase 2.3) diff --git a/docs/api/type-aliases/SageMakerStreamingToolCall.md b/docs/api/type-aliases/SageMakerStreamingToolCall.md index bd579ca80..9375dc182 100644 --- a/docs/api/type-aliases/SageMakerStreamingToolCall.md +++ b/docs/api/type-aliases/SageMakerStreamingToolCall.md @@ -8,7 +8,7 @@ > **SageMakerStreamingToolCall** = `object` -Defined in: [types/providers.ts:1587](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1587) +Defined in: [types/providers.ts:1597](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1597) Streaming tool call information (Phase 2.3) @@ -18,7 +18,7 @@ Streaming tool call information (Phase 2.3) > **id**: `string` -Defined in: [types/providers.ts:1589](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1589) +Defined in: [types/providers.ts:1599](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1599) Tool call identifier @@ -28,7 +28,7 @@ Tool call identifier > `optional` **name?**: `string` -Defined in: [types/providers.ts:1591](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1591) +Defined in: [types/providers.ts:1601](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1601) Tool/function name @@ -38,7 +38,7 @@ Tool/function name > `optional` **arguments?**: `string` -Defined in: [types/providers.ts:1593](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1593) +Defined in: [types/providers.ts:1603](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1603) Partial or complete arguments as JSON string @@ -48,7 +48,7 @@ Partial or complete arguments as JSON string > **type**: `"function"` -Defined in: [types/providers.ts:1595](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1595) +Defined in: [types/providers.ts:1605](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1605) Tool call type @@ -58,7 +58,7 @@ Tool call type > `optional` **complete?**: `boolean` -Defined in: [types/providers.ts:1597](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1597) +Defined in: [types/providers.ts:1607](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1607) Indicates if this tool call is complete @@ -68,6 +68,6 @@ Indicates if this tool call is complete > `optional` **argumentsDelta?**: `string` -Defined in: [types/providers.ts:1599](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1599) +Defined in: [types/providers.ts:1609](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1609) Delta text for incremental argument building diff --git a/docs/api/type-aliases/SageMakerStreamingToolResult.md b/docs/api/type-aliases/SageMakerStreamingToolResult.md index 0368dee4b..b7e2be56d 100644 --- a/docs/api/type-aliases/SageMakerStreamingToolResult.md +++ b/docs/api/type-aliases/SageMakerStreamingToolResult.md @@ -8,7 +8,7 @@ > **SageMakerStreamingToolResult** = `object` -Defined in: [types/providers.ts:1605](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1605) +Defined in: [types/providers.ts:1615](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1615) Streaming tool result information (Phase 2.3) @@ -18,7 +18,7 @@ Streaming tool result information (Phase 2.3) > **toolCallId**: `string` -Defined in: [types/providers.ts:1607](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1607) +Defined in: [types/providers.ts:1617](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1617) Tool call identifier @@ -28,7 +28,7 @@ Tool call identifier > **toolName**: `string` -Defined in: [types/providers.ts:1609](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1609) +Defined in: [types/providers.ts:1619](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1619) Tool name @@ -38,7 +38,7 @@ Tool name > `optional` **result?**: `unknown` -Defined in: [types/providers.ts:1611](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1611) +Defined in: [types/providers.ts:1621](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1621) Partial or complete result data @@ -48,7 +48,7 @@ Partial or complete result data > `optional` **resultDelta?**: `string` -Defined in: [types/providers.ts:1613](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1613) +Defined in: [types/providers.ts:1623](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1623) Result delta for incremental responses @@ -58,7 +58,7 @@ Result delta for incremental responses > **status**: `"pending"` \| `"running"` \| `"success"` \| `"error"` -Defined in: [types/providers.ts:1615](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1615) +Defined in: [types/providers.ts:1625](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1625) Execution status @@ -68,7 +68,7 @@ Execution status > `optional` **error?**: `string` -Defined in: [types/providers.ts:1617](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1617) +Defined in: [types/providers.ts:1627](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1627) Error message if status is error @@ -78,6 +78,6 @@ Error message if status is error > `optional` **complete?**: `boolean` -Defined in: [types/providers.ts:1619](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1619) +Defined in: [types/providers.ts:1629](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1629) Indicates if this result is complete diff --git a/docs/api/type-aliases/SageMakerStructuredOutput.md b/docs/api/type-aliases/SageMakerStructuredOutput.md index 7a6d7a9ce..fbdf2e270 100644 --- a/docs/api/type-aliases/SageMakerStructuredOutput.md +++ b/docs/api/type-aliases/SageMakerStructuredOutput.md @@ -8,7 +8,7 @@ > **SageMakerStructuredOutput** = `object` -Defined in: [types/providers.ts:1625](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1625) +Defined in: [types/providers.ts:1635](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1635) Structured output streaming information (Phase 2.3) @@ -18,7 +18,7 @@ Structured output streaming information (Phase 2.3) > `optional` **partialObject?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:1627](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1627) +Defined in: [types/providers.ts:1637](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1637) Partial JSON object being built @@ -28,7 +28,7 @@ Partial JSON object being built > `optional` **jsonDelta?**: `string` -Defined in: [types/providers.ts:1629](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1629) +Defined in: [types/providers.ts:1639](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1639) JSON delta text @@ -38,7 +38,7 @@ JSON delta text > `optional` **currentPath?**: `string` -Defined in: [types/providers.ts:1631](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1631) +Defined in: [types/providers.ts:1641](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1641) Current parsing path (e.g., "user.name") @@ -48,7 +48,7 @@ Current parsing path (e.g., "user.name") > `optional` **validationErrors?**: `string`[] -Defined in: [types/providers.ts:1633](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1633) +Defined in: [types/providers.ts:1643](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1643) Schema validation errors @@ -58,7 +58,7 @@ Schema validation errors > `optional` **complete?**: `boolean` -Defined in: [types/providers.ts:1635](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1635) +Defined in: [types/providers.ts:1645](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1645) Indicates if JSON is complete and valid @@ -68,6 +68,6 @@ Indicates if JSON is complete and valid > `optional` **schema?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:1637](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1637) +Defined in: [types/providers.ts:1647](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1647) JSON schema being validated against diff --git a/docs/api/type-aliases/SageMakerToolCall.md b/docs/api/type-aliases/SageMakerToolCall.md index c95734c8d..fc9a82bcc 100644 --- a/docs/api/type-aliases/SageMakerToolCall.md +++ b/docs/api/type-aliases/SageMakerToolCall.md @@ -8,7 +8,7 @@ > **SageMakerToolCall** = `object` -Defined in: [types/providers.ts:1557](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1557) +Defined in: [types/providers.ts:1567](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1567) Tool call information for function calling @@ -18,7 +18,7 @@ Tool call information for function calling > **id**: `string` -Defined in: [types/providers.ts:1559](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1559) +Defined in: [types/providers.ts:1569](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1569) Tool call identifier @@ -28,7 +28,7 @@ Tool call identifier > **name**: `string` -Defined in: [types/providers.ts:1561](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1561) +Defined in: [types/providers.ts:1571](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1571) Tool/function name @@ -38,7 +38,7 @@ Tool/function name > **arguments**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:1563](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1563) +Defined in: [types/providers.ts:1573](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1573) Tool arguments as JSON object @@ -48,6 +48,6 @@ Tool arguments as JSON object > **type**: `"function"` -Defined in: [types/providers.ts:1565](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1565) +Defined in: [types/providers.ts:1575](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1575) Tool call type diff --git a/docs/api/type-aliases/SageMakerToolResult.md b/docs/api/type-aliases/SageMakerToolResult.md index 5ca3e2651..1a885fed7 100644 --- a/docs/api/type-aliases/SageMakerToolResult.md +++ b/docs/api/type-aliases/SageMakerToolResult.md @@ -8,7 +8,7 @@ > **SageMakerToolResult** = `object` -Defined in: [types/providers.ts:1571](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1571) +Defined in: [types/providers.ts:1581](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1581) Tool result information @@ -18,7 +18,7 @@ Tool result information > **toolCallId**: `string` -Defined in: [types/providers.ts:1573](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1573) +Defined in: [types/providers.ts:1583](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1583) Tool call identifier @@ -28,7 +28,7 @@ Tool call identifier > **toolName**: `string` -Defined in: [types/providers.ts:1575](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1575) +Defined in: [types/providers.ts:1585](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1585) Tool name @@ -38,7 +38,7 @@ Tool name > **result**: `unknown` -Defined in: [types/providers.ts:1577](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1577) +Defined in: [types/providers.ts:1587](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1587) Tool result data @@ -48,7 +48,7 @@ Tool result data > **status**: `"success"` \| `"error"` -Defined in: [types/providers.ts:1579](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1579) +Defined in: [types/providers.ts:1589](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1589) Execution status @@ -58,6 +58,6 @@ Execution status > `optional` **error?**: `string` -Defined in: [types/providers.ts:1581](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1581) +Defined in: [types/providers.ts:1591](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L1591) Error message if status is error diff --git a/docs/api/type-aliases/StepFinishEvent.md b/docs/api/type-aliases/StepFinishEvent.md index 638f0181c..537f0fb0f 100644 --- a/docs/api/type-aliases/StepFinishEvent.md +++ b/docs/api/type-aliases/StepFinishEvent.md @@ -8,7 +8,7 @@ > **StepFinishEvent** = `object` -Defined in: [types/providers.ts:2094](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2094) +Defined in: [types/providers.ts:2104](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2104) Step finish event shape for multi-step generation. @@ -22,7 +22,7 @@ Step finish event shape for multi-step generation. > `readonly` **toolCalls**: `ReadonlyArray`\<`unknown`\> -Defined in: [types/providers.ts:2095](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2095) +Defined in: [types/providers.ts:2105](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2105) --- @@ -30,7 +30,7 @@ Defined in: [types/providers.ts:2095](https://github.com/juspay/neurolink/blob/r > `readonly` **toolResults**: `ReadonlyArray`\<`unknown`\> -Defined in: [types/providers.ts:2096](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2096) +Defined in: [types/providers.ts:2106](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2106) --- @@ -38,7 +38,7 @@ Defined in: [types/providers.ts:2096](https://github.com/juspay/neurolink/blob/r > `readonly` **text**: `string` -Defined in: [types/providers.ts:2097](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2097) +Defined in: [types/providers.ts:2107](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2107) --- @@ -46,7 +46,7 @@ Defined in: [types/providers.ts:2097](https://github.com/juspay/neurolink/blob/r > `readonly` **finishReason**: `string` -Defined in: [types/providers.ts:2098](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2098) +Defined in: [types/providers.ts:2108](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2108) --- @@ -54,7 +54,7 @@ Defined in: [types/providers.ts:2098](https://github.com/juspay/neurolink/blob/r > `readonly` **usage**: `object` -Defined in: [types/providers.ts:2099](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2099) +Defined in: [types/providers.ts:2109](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2109) #### inputTokens? diff --git a/docs/api/type-aliases/ToolWithLegacyParams.md b/docs/api/type-aliases/ToolWithLegacyParams.md index 23d1de13a..b86fa8bd8 100644 --- a/docs/api/type-aliases/ToolWithLegacyParams.md +++ b/docs/api/type-aliases/ToolWithLegacyParams.md @@ -8,7 +8,7 @@ > **ToolWithLegacyParams** = `object` -Defined in: [types/providers.ts:2107](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2107) +Defined in: [types/providers.ts:2117](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2117) Represents an AI SDK Tool that may carry a legacy `parameters` field (from AI SDK v3/v4) in addition to the current `inputSchema`. @@ -19,7 +19,7 @@ Represents an AI SDK Tool that may carry a legacy `parameters` field > `optional` **description?**: `string` -Defined in: [types/providers.ts:2108](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2108) +Defined in: [types/providers.ts:2118](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2118) --- @@ -27,7 +27,7 @@ Defined in: [types/providers.ts:2108](https://github.com/juspay/neurolink/blob/r > `optional` **inputSchema?**: `unknown` -Defined in: [types/providers.ts:2109](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2109) +Defined in: [types/providers.ts:2119](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2119) --- @@ -35,7 +35,7 @@ Defined in: [types/providers.ts:2109](https://github.com/juspay/neurolink/blob/r > `optional` **execute?**: (...`args`) => `unknown` -Defined in: [types/providers.ts:2110](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2110) +Defined in: [types/providers.ts:2120](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2120) #### Parameters @@ -53,6 +53,6 @@ Defined in: [types/providers.ts:2110](https://github.com/juspay/neurolink/blob/r > `optional` **parameters?**: `unknown` -Defined in: [types/providers.ts:2112](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2112) +Defined in: [types/providers.ts:2122](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2122) Legacy field from AI SDK v3/v4 diff --git a/docs/api/type-aliases/VertexAnthropicCacheControl.md b/docs/api/type-aliases/VertexAnthropicCacheControl.md index 67369ca10..b94da69af 100644 --- a/docs/api/type-aliases/VertexAnthropicCacheControl.md +++ b/docs/api/type-aliases/VertexAnthropicCacheControl.md @@ -8,7 +8,7 @@ > **VertexAnthropicCacheControl** = `object` -Defined in: [types/providers.ts:2438](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2438) +Defined in: [types/providers.ts:2448](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2448) Anthropic ephemeral prompt-cache breakpoint marker. Placed on a content block / tool / system block to make the rendered prefix up to that point a @@ -21,4 +21,4 @@ are the only way the conversation prefix is cached across turns. > **type**: `"ephemeral"` -Defined in: [types/providers.ts:2438](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2438) +Defined in: [types/providers.ts:2448](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2448) diff --git a/docs/api/type-aliases/VertexAnthropicCacheInput.md b/docs/api/type-aliases/VertexAnthropicCacheInput.md index 6e2c9ad30..ec5e8ad72 100644 --- a/docs/api/type-aliases/VertexAnthropicCacheInput.md +++ b/docs/api/type-aliases/VertexAnthropicCacheInput.md @@ -8,7 +8,7 @@ > **VertexAnthropicCacheInput** = `object` -Defined in: [types/providers.ts:2510](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2510) +Defined in: [types/providers.ts:2520](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2520) Input to `applyVertexAnthropicCacheBreakpoints`. @@ -18,7 +18,7 @@ Input to `applyVertexAnthropicCacheBreakpoints`. > `optional` **system?**: `string` -Defined in: [types/providers.ts:2511](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2511) +Defined in: [types/providers.ts:2521](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2521) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2511](https://github.com/juspay/neurolink/blob/r > `optional` **tools?**: [`VertexAnthropicTool`](VertexAnthropicTool.md)[] -Defined in: [types/providers.ts:2512](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2512) +Defined in: [types/providers.ts:2522](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2522) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2512](https://github.com/juspay/neurolink/blob/r > **messages**: [`VertexAnthropicMessage`](VertexAnthropicMessage.md)[] -Defined in: [types/providers.ts:2513](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2513) +Defined in: [types/providers.ts:2523](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2523) --- @@ -42,7 +42,7 @@ Defined in: [types/providers.ts:2513](https://github.com/juspay/neurolink/blob/r > `optional` **maxHistoryBreakpoints?**: `number` -Defined in: [types/providers.ts:2520](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2520) +Defined in: [types/providers.ts:2530](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2530) Cap on how many of the most-recent messages receive a rolling history breakpoint. Defaults to "use the remaining budget". Two or more gives diff --git a/docs/api/type-aliases/VertexAnthropicCacheOutput.md b/docs/api/type-aliases/VertexAnthropicCacheOutput.md index 5daaad206..4c28d28ff 100644 --- a/docs/api/type-aliases/VertexAnthropicCacheOutput.md +++ b/docs/api/type-aliases/VertexAnthropicCacheOutput.md @@ -8,7 +8,7 @@ > **VertexAnthropicCacheOutput** = `object` -Defined in: [types/providers.ts:2524](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2524) +Defined in: [types/providers.ts:2534](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2534) Output of `applyVertexAnthropicCacheBreakpoints` — a cache-annotated request. @@ -18,7 +18,7 @@ Output of `applyVertexAnthropicCacheBreakpoints` — a cache-annotated request. > `optional` **system?**: `string` \| [`VertexAnthropicSystemBlock`](VertexAnthropicSystemBlock.md)[] -Defined in: [types/providers.ts:2525](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2525) +Defined in: [types/providers.ts:2535](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2535) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2525](https://github.com/juspay/neurolink/blob/r > `optional` **tools?**: [`VertexAnthropicTool`](VertexAnthropicTool.md)[] -Defined in: [types/providers.ts:2526](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2526) +Defined in: [types/providers.ts:2536](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2536) --- @@ -34,4 +34,4 @@ Defined in: [types/providers.ts:2526](https://github.com/juspay/neurolink/blob/r > **messages**: [`VertexAnthropicMessage`](VertexAnthropicMessage.md)[] -Defined in: [types/providers.ts:2527](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2527) +Defined in: [types/providers.ts:2537](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2537) diff --git a/docs/api/type-aliases/VertexAnthropicContentBlock.md b/docs/api/type-aliases/VertexAnthropicContentBlock.md index 7bcc17ed5..dadc177ec 100644 --- a/docs/api/type-aliases/VertexAnthropicContentBlock.md +++ b/docs/api/type-aliases/VertexAnthropicContentBlock.md @@ -8,7 +8,7 @@ > **VertexAnthropicContentBlock** = \{ `type`: `"text"`; `text`: `string`; \} \| \{ `type`: `"tool_use"`; `id`: `string`; `name`: `string`; `input`: `Record`\<`string`, `unknown`\>; \} \| \{ `type`: `"tool_result"`; `tool_use_id`: `string`; `content`: `string`; \} -Defined in: [types/providers.ts:2534](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2534) +Defined in: [types/providers.ts:2544](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2544) Content block variants returned by the Anthropic Vertex SDK during streaming and generation — used to narrow responses before handing tool calls back. diff --git a/docs/api/type-aliases/VertexAnthropicMessage.md b/docs/api/type-aliases/VertexAnthropicMessage.md index a05559070..e03296bb0 100644 --- a/docs/api/type-aliases/VertexAnthropicMessage.md +++ b/docs/api/type-aliases/VertexAnthropicMessage.md @@ -8,7 +8,7 @@ > **VertexAnthropicMessage** = `object` -Defined in: [types/providers.ts:2440](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2440) +Defined in: [types/providers.ts:2450](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2450) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:2440](https://github.com/juspay/neurolink/blob/r > **role**: `"user"` \| `"assistant"` -Defined in: [types/providers.ts:2441](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2441) +Defined in: [types/providers.ts:2451](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2451) --- @@ -24,4 +24,4 @@ Defined in: [types/providers.ts:2441](https://github.com/juspay/neurolink/blob/r > **content**: `string` \| (\{ `type`: `"text"`; `text`: `string`; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"image"`; `source`: \{ `type`: `"base64"`; `media_type`: `string`; `data`: `string`; \}; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"document"`; `source`: \{ `type`: `"base64"`; `media_type`: `string`; `data`: `string`; \}; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"tool_use"`; `id`: `string`; `name`: `string`; `input`: `unknown`; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"tool_result"`; `tool_use_id`: `string`; `content`: `string`; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"thinking"`; `thinking`: `string`; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \} \| \{ `type`: `"redacted_thinking"`; `data`: `string`; `cache_control?`: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md); \})[] -Defined in: [types/providers.ts:2442](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2442) +Defined in: [types/providers.ts:2452](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2452) diff --git a/docs/api/type-aliases/VertexAnthropicSystemBlock.md b/docs/api/type-aliases/VertexAnthropicSystemBlock.md index 8646b189d..01afd9d26 100644 --- a/docs/api/type-aliases/VertexAnthropicSystemBlock.md +++ b/docs/api/type-aliases/VertexAnthropicSystemBlock.md @@ -8,7 +8,7 @@ > **VertexAnthropicSystemBlock** = `object` -Defined in: [types/providers.ts:2491](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2491) +Defined in: [types/providers.ts:2501](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2501) System prompt block form accepted by the Anthropic Vertex SDK. Used instead of a bare string when a `cache_control` breakpoint must ride on the system @@ -20,7 +20,7 @@ prompt (a string `system` cannot carry one). > **type**: `"text"` -Defined in: [types/providers.ts:2492](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2492) +Defined in: [types/providers.ts:2502](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2502) --- @@ -28,7 +28,7 @@ Defined in: [types/providers.ts:2492](https://github.com/juspay/neurolink/blob/r > **text**: `string` -Defined in: [types/providers.ts:2493](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2493) +Defined in: [types/providers.ts:2503](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2503) --- @@ -36,4 +36,4 @@ Defined in: [types/providers.ts:2493](https://github.com/juspay/neurolink/blob/r > `optional` **cache_control?**: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md) -Defined in: [types/providers.ts:2494](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2494) +Defined in: [types/providers.ts:2504](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2504) diff --git a/docs/api/type-aliases/VertexAnthropicTool.md b/docs/api/type-aliases/VertexAnthropicTool.md index 6d984e216..dc06a0bc7 100644 --- a/docs/api/type-aliases/VertexAnthropicTool.md +++ b/docs/api/type-aliases/VertexAnthropicTool.md @@ -8,7 +8,7 @@ > **VertexAnthropicTool** = `object` -Defined in: [types/providers.ts:2498](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2498) +Defined in: [types/providers.ts:2508](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2508) Tool definition accepted by the Anthropic Vertex SDK. @@ -18,7 +18,7 @@ Tool definition accepted by the Anthropic Vertex SDK. > **name**: `string` -Defined in: [types/providers.ts:2499](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2499) +Defined in: [types/providers.ts:2509](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2509) --- @@ -26,7 +26,7 @@ Defined in: [types/providers.ts:2499](https://github.com/juspay/neurolink/blob/r > **description**: `string` -Defined in: [types/providers.ts:2500](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2500) +Defined in: [types/providers.ts:2510](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2510) --- @@ -34,7 +34,7 @@ Defined in: [types/providers.ts:2500](https://github.com/juspay/neurolink/blob/r > **input_schema**: `object` -Defined in: [types/providers.ts:2501](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2501) +Defined in: [types/providers.ts:2511](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2511) #### type @@ -54,4 +54,4 @@ Defined in: [types/providers.ts:2501](https://github.com/juspay/neurolink/blob/r > `optional` **cache_control?**: [`VertexAnthropicCacheControl`](VertexAnthropicCacheControl.md) -Defined in: [types/providers.ts:2506](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2506) +Defined in: [types/providers.ts:2516](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2516) diff --git a/docs/api/type-aliases/VertexGenaiFunctionDeclaration.md b/docs/api/type-aliases/VertexGenaiFunctionDeclaration.md index d8968be92..354aec2d2 100644 --- a/docs/api/type-aliases/VertexGenaiFunctionDeclaration.md +++ b/docs/api/type-aliases/VertexGenaiFunctionDeclaration.md @@ -8,7 +8,7 @@ > **VertexGenaiFunctionDeclaration** = `object` -Defined in: [types/providers.ts:2418](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2418) +Defined in: [types/providers.ts:2428](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2428) Function declaration shape accepted by the @google/genai SDK when tools are attached to a Vertex generateContent call. @@ -19,7 +19,7 @@ attached to a Vertex generateContent call. > **name**: `string` -Defined in: [types/providers.ts:2419](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2419) +Defined in: [types/providers.ts:2429](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2429) --- @@ -27,7 +27,7 @@ Defined in: [types/providers.ts:2419](https://github.com/juspay/neurolink/blob/r > **description**: `string` -Defined in: [types/providers.ts:2420](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2420) +Defined in: [types/providers.ts:2430](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2430) --- @@ -35,4 +35,4 @@ Defined in: [types/providers.ts:2420](https://github.com/juspay/neurolink/blob/r > `optional` **parametersJsonSchema?**: `Record`\<`string`, `unknown`\> -Defined in: [types/providers.ts:2421](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2421) +Defined in: [types/providers.ts:2431](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2431) diff --git a/docs/api/type-aliases/VertexNativeLoopPart.md b/docs/api/type-aliases/VertexNativeLoopPart.md index 5336e67fd..88003f47b 100644 --- a/docs/api/type-aliases/VertexNativeLoopPart.md +++ b/docs/api/type-aliases/VertexNativeLoopPart.md @@ -8,7 +8,7 @@ > **VertexNativeLoopPart** = [`VertexNativePart`](VertexNativePart.md) \| \{ `functionCall`: \{ `name`: `string`; `args`: `Record`\<`string`, `unknown`\>; \}; \} \| \{ `functionResponse`: \{ `name`: `string`; `response`: `Record`\<`string`, `unknown`\>; \}; \} -Defined in: [types/providers.ts:2372](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2372) +Defined in: [types/providers.ts:2382](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2382) Part variants that ride the native Gemini agentic tool loop in addition to the plain `VertexNativePart` content shapes: model-issued function calls diff --git a/docs/api/type-aliases/VertexNativePart.md b/docs/api/type-aliases/VertexNativePart.md index bccf6e9a4..bb40c9bb4 100644 --- a/docs/api/type-aliases/VertexNativePart.md +++ b/docs/api/type-aliases/VertexNativePart.md @@ -8,7 +8,7 @@ > **VertexNativePart** = \{ `text`: `string`; \} \| \{ `inlineData`: \{ `mimeType`: `string`; `data`: `string`; \}; \} -Defined in: [types/providers.ts:2360](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2360) +Defined in: [types/providers.ts:2370](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2370) Single part inside a Google Vertex "native" (non-AI-SDK) generateContent payload — either inline text or an inline base64 data blob. diff --git a/docs/api/type-aliases/VertexRegularSegment.md b/docs/api/type-aliases/VertexRegularSegment.md index 0e8520323..3314bacd8 100644 --- a/docs/api/type-aliases/VertexRegularSegment.md +++ b/docs/api/type-aliases/VertexRegularSegment.md @@ -8,7 +8,7 @@ > **VertexRegularSegment** = `object` -Defined in: [types/providers.ts:2406](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2406) +Defined in: [types/providers.ts:2416](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2416) ## Properties @@ -16,7 +16,7 @@ Defined in: [types/providers.ts:2406](https://github.com/juspay/neurolink/blob/r > **type**: `"regular"` -Defined in: [types/providers.ts:2407](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2407) +Defined in: [types/providers.ts:2417](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2417) --- @@ -24,7 +24,7 @@ Defined in: [types/providers.ts:2407](https://github.com/juspay/neurolink/blob/r > **role**: `string` -Defined in: [types/providers.ts:2408](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2408) +Defined in: [types/providers.ts:2418](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2418) --- @@ -32,4 +32,4 @@ Defined in: [types/providers.ts:2408](https://github.com/juspay/neurolink/blob/r > **parts**: `unknown`[] -Defined in: [types/providers.ts:2409](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2409) +Defined in: [types/providers.ts:2419](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2419) diff --git a/docs/api/type-aliases/VertexSegment.md b/docs/api/type-aliases/VertexSegment.md index f72d8b81f..be83c12c1 100644 --- a/docs/api/type-aliases/VertexSegment.md +++ b/docs/api/type-aliases/VertexSegment.md @@ -8,4 +8,4 @@ > **VertexSegment** = [`VertexToolStep`](VertexToolStep.md) \| [`VertexRegularSegment`](VertexRegularSegment.md) -Defined in: [types/providers.ts:2412](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2412) +Defined in: [types/providers.ts:2422](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2422) diff --git a/docs/api/type-aliases/VertexToolStep.md b/docs/api/type-aliases/VertexToolStep.md index aef96347e..7bc430445 100644 --- a/docs/api/type-aliases/VertexToolStep.md +++ b/docs/api/type-aliases/VertexToolStep.md @@ -8,7 +8,7 @@ > **VertexToolStep** = `object` -Defined in: [types/providers.ts:2400](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2400) +Defined in: [types/providers.ts:2410](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2410) Internal helpers used by the conversation-history builder in providers/googleVertex.ts to merge interleaved tool call / result turns. @@ -19,7 +19,7 @@ providers/googleVertex.ts to merge interleaved tool call / result turns. > **type**: `"tool_step"` -Defined in: [types/providers.ts:2401](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2401) +Defined in: [types/providers.ts:2411](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2411) --- @@ -27,7 +27,7 @@ Defined in: [types/providers.ts:2401](https://github.com/juspay/neurolink/blob/r > **callParts**: `unknown`[] -Defined in: [types/providers.ts:2402](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2402) +Defined in: [types/providers.ts:2412](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2412) --- @@ -35,4 +35,4 @@ Defined in: [types/providers.ts:2402](https://github.com/juspay/neurolink/blob/r > **resultParts**: `unknown`[] -Defined in: [types/providers.ts:2403](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2403) +Defined in: [types/providers.ts:2413](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2413) diff --git a/docs/api/type-aliases/VertexUsageCounter.md b/docs/api/type-aliases/VertexUsageCounter.md index 2ed27a08c..9956c424e 100644 --- a/docs/api/type-aliases/VertexUsageCounter.md +++ b/docs/api/type-aliases/VertexUsageCounter.md @@ -8,7 +8,7 @@ > **VertexUsageCounter** = `"input"` \| `"output"` \| `"cacheRead"` \| `"reasoning"` -Defined in: [types/providers.ts:2058](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2058) +Defined in: [types/providers.ts:2068](https://github.com/juspay/neurolink/blob/release/src/lib/types/providers.ts#L2068) Which turn-level counter a per-chunk Vertex usage delta belongs to. diff --git a/src/lib/providers/sagemaker/client.ts b/src/lib/providers/sagemaker/client.ts index d7109e546..98652882a 100644 --- a/src/lib/providers/sagemaker/client.ts +++ b/src/lib/providers/sagemaker/client.ts @@ -26,6 +26,7 @@ import { getRetryDelay, } from "./errors.js"; import { logger } from "../../utils/logger.js"; +import { isAbortError } from "../../utils/errorHandling.js"; import { tryImport } from "../../utils/tryImport.js"; /** @@ -163,7 +164,12 @@ export class SageMakerRuntimeClient { const command = new InvokeEndpointCommand(input); const client = await this.getClient(); const response = (await this.executeWithRetry( - () => client.send(command), + // The signal goes to the transport, not just to whatever loop is + // above us: without it an aborted call keeps its HTTP request in + // flight until the endpoint answers. An AbortError matches none of + // RETRYABLE_ERROR_CONDITIONS, so executeWithRetry surfaces it rather + // than re-issuing a request the caller has already abandoned. + () => client.send(command, { abortSignal: params.abortSignal }), params.EndpointName, )) as InvokeEndpointCommandOutput; @@ -182,6 +188,16 @@ export class SageMakerRuntimeClient { CustomAttributes: response.CustomAttributes, }; } catch (error) { + // The signal now reaches the transport, so this catch sees real + // AbortErrors for the first time — and must not wrap them. + // SageMakerError's constructor overwrites `.name`, and its generic + // fallback stamps `statusCode: 500`, which the retry classifier reads as + // "transient, try again". That fabricated status is what turned a + // cancellation into three attempts and 22 seconds. + if (isAbortError(error)) { + throw error; + } + const duration = Date.now() - startTime; logger.error("SageMaker endpoint invocation failed", { endpointName: params.EndpointName, @@ -233,7 +249,9 @@ export class SageMakerRuntimeClient { const command = new InvokeEndpointWithResponseStreamCommand(input); const client = await this.getClient(); const response = (await this.executeWithRetry( - () => client.send(command), + // As above — an abort must tear down the response stream's connection, + // not merely stop the consumer reading from it. + () => client.send(command, { abortSignal: params.abortSignal }), params.EndpointName, )) as InvokeEndpointWithResponseStreamCommandOutput; @@ -264,6 +282,16 @@ export class SageMakerRuntimeClient { InvokedProductionVariant: response.InvokedProductionVariant, }; } catch (error) { + // The signal now reaches the transport, so the streaming catch sees real + // AbortErrors for the first time — and must not wrap them. + // SageMakerError's constructor overwrites `.name`, and its generic + // fallback stamps `statusCode: 500`, which the retry classifier reads as + // "transient, try again". That fabricated status is what turned a + // cancellation into three attempts and 22 seconds. + if (isAbortError(error)) { + throw error; + } + const duration = Date.now() - startTime; logger.error("SageMaker streaming invocation failed", { endpointName: params.EndpointName, diff --git a/src/lib/providers/sagemaker/language-model.ts b/src/lib/providers/sagemaker/language-model.ts index a59de5c87..64acb472d 100644 --- a/src/lib/providers/sagemaker/language-model.ts +++ b/src/lib/providers/sagemaker/language-model.ts @@ -26,6 +26,7 @@ import type { } from "../../types/index.js"; import { createAdaptiveSemaphore } from "./adaptive-semaphore.js"; import { logger } from "../../utils/logger.js"; +import { isAbortError } from "../../utils/errorHandling.js"; /** * Base synthetic streaming delay in milliseconds for simulating real-time response @@ -158,6 +159,21 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { }); } + /** + * Read the caller's abort signal out of the AI SDK's call options. + * + * `doGenerate`/`doStream` type `options` as `Record`, so the + * value arrives as `unknown` even though `LanguageModelV2CallOptions` + * declares `abortSignal?: AbortSignal`. `instanceof` is a real runtime check + * rather than an assertion, which is what rule 14 asks for here. + */ + private readAbortSignal( + options: Record, + ): AbortSignal | undefined { + const signal = options.abortSignal; + return signal instanceof AbortSignal ? signal : undefined; + } + /** * Generate text synchronously using SageMaker endpoint */ @@ -223,6 +239,7 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { Body: JSON.stringify(sagemakerRequest), ContentType: "application/json", Accept: "application/json", + abortSignal: this.readAbortSignal(options), }); // Parse SageMaker response @@ -364,6 +381,11 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { error: error instanceof Error ? error.message : String(error), }); + // An abort is not a provider failure: wrapping it here would restore + // the fabricated 500 the client guard just avoided. + if (isAbortError(error)) { + throw error; + } throw handleSageMakerError(error, this.modelConfig.endpointName); } } @@ -423,6 +445,7 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { Body: JSON.stringify(requestWithStreaming), ContentType: this.modelConfig.contentType || "application/json", Accept: this.modelConfig.accept || "application/json", + abortSignal: this.readAbortSignal(options), }); // Create intelligent streaming response @@ -468,6 +491,14 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { }, }; } catch (streamingError) { + // A cancelled turn is not a missing capability. This fallback exists + // for endpoints that cannot stream; re-issuing doGenerate() here with + // the same already-aborted signal only adds a wasted call and a + // misleading warning before the abort surfaces anyway. + if (isAbortError(streamingError)) { + throw streamingError; + } + logger.warn("Streaming failed, falling back to non-streaming", { endpointName: this.modelConfig.endpointName, error: @@ -532,6 +563,11 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { error: error instanceof Error ? error.message : String(error), }); + // An abort is not a provider failure: wrapping it here would restore + // the fabricated 500 the client guard just avoided. + if (isAbortError(error)) { + throw error; + } throw handleSageMakerError(error, this.modelConfig.endpointName); } } @@ -944,6 +980,11 @@ export class SageMakerLanguageModel implements SageMakerAsLanguageModel { batchSize: prompts.length, }); + // An abort is not a provider failure: wrapping it here would restore + // the fabricated 500 the client guard just avoided. + if (isAbortError(error)) { + throw error; + } throw handleSageMakerError(error, this.modelConfig.endpointName); } } diff --git a/src/lib/types/providers.ts b/src/lib/types/providers.ts index 018e3a7a2..efa371965 100644 --- a/src/lib/types/providers.ts +++ b/src/lib/types/providers.ts @@ -1508,6 +1508,16 @@ export type InvokeEndpointParams = { TargetVariant?: string; /** Inference ID for request tracking */ InferenceId?: string; + /** + * Cancels the in-flight HTTP request, not just the loop around it. + * + * Named in camelCase deliberately: every other field here mirrors an AWS + * `InvokeEndpointCommandInput` member and keeps its PascalCase, whereas this + * one is a transport option handed to `client.send()` as + * `@smithy/types` `HttpHandlerOptions` — it is never part of the command + * payload, and spelling it differently keeps that boundary visible. + */ + abortSignal?: AbortSignal; }; /** diff --git a/test/continuous-test-suite-sagemaker-streaming.ts b/test/continuous-test-suite-sagemaker-streaming.ts index 6a375d9e6..cef7749ff 100644 --- a/test/continuous-test-suite-sagemaker-streaming.ts +++ b/test/continuous-test-suite-sagemaker-streaming.ts @@ -328,4 +328,113 @@ await test("a call with no per-request credentials still uses the environment", } }); +/** + * A stand-in that accepts the request and never answers, so the only thing + * that can end the call is the caller's abort. + */ +async function startSilentStandIn(): Promise { + let requests = 0; + const sockets = new Set<{ destroy: () => void }>(); + const server: Server = createServer((req) => { + requests++; + req.resume(); + }); + server.on("connection", (socket) => { + sockets.add(socket); + socket.on("close", () => sockets.delete(socket)); + }); + await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve)); + const address = server.address(); + return { + get requests() { + return requests; + }, + port: typeof address === "object" && address ? address.port : 0, + close: async () => { + for (const socket of sockets) { + socket.destroy(); + } + await new Promise((resolve) => server.close(() => resolve())); + }, + } as StandIn; +} + +await test("an aborted SageMaker turn ends promptly and still reads as an abort", async () => { + // Two properties, and the suite needs both because fixing either alone still + // leaves cancellation broken. + // + // Wiring the signal into the transport is what first lets client.send() + // reject on abort. But SageMakerError's constructor overwrites `.name`, and + // handleSageMakerError()'s generic fallback stamps `statusCode: 500` on + // anything it does not recognise. The retry classifier duck-types that + // status, reads 5xx as transient, and re-runs the turn twice more at the + // 10s no-hint floor — each attempt rejecting instantly because the signal is + // still aborted, without a request ever leaving the process. + // + // Measured before the fix: 21,996ms and `name` reading "Error". After: about + // half a second and "AbortError". The bound below is deliberately far above + // the observed figure and far below one retry cycle, so this fails on the + // regression rather than on a slow machine. + const server = await startSilentStandIn(); + const restoreEnv = withoutAwsEnv(); + // The MCP path resolves the provider differently and does not carry the + // per-request credentials this suite relies on; skipping it keeps the case + // about cancellation rather than about provider construction. + const priorSkipMcp = process.env.NEUROLINK_SKIP_MCP; + process.env.NEUROLINK_SKIP_MCP = "true"; + const controller = new AbortController(); + const startedAt = Date.now(); + let thrown: unknown; + try { + const nl = new NeuroLink(); + const timer = setTimeout(() => controller.abort(), 300); + try { + await nl.generate({ + input: { text: "hi" }, + provider: "sagemaker", + maxTokens: 16, + credentials: credentialsFor(server.port), + abortSignal: controller.signal, + }); + } catch (error) { + thrown = error; + } finally { + clearTimeout(timer); + } + const elapsed = Date.now() - startedAt; + + // Precondition first: an assertion about the abort means nothing unless + // the request actually went out and the signal actually fired. + assert( + server.requests > 0, + "the endpoint was never reached, so the abort path was not exercised", + ); + assert( + controller.signal.aborted, + "the signal never fired, so the turn ended for some other reason", + ); + assert(thrown !== undefined, "the aborted turn ended without any error"); + + // Shape only — never the payload. A message quoting provider-ish text is + // reclassified as a skip by isExpectedProviderError() and would hide this. + const name = thrown instanceof Error ? thrown.name : ""; + assert( + name === "AbortError", + "the cancellation lost its identity before reaching the caller", + ); + assert( + elapsed < 5_000, + "the aborted turn was retried instead of ending, exceeding the bound", + ); + } finally { + if (priorSkipMcp === undefined) { + delete process.env.NEUROLINK_SKIP_MCP; + } else { + process.env.NEUROLINK_SKIP_MCP = priorSkipMcp; + } + restoreEnv(); + await server.close(); + } +}); + await runSuite();