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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/api/type-aliases/OpenAICompatBuildBodyArgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@

> **OpenAICompatBuildBodyArgs** = `object`

Defined in: [types/openaiCompatible.ts:318](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L318)
Defined in: [types/openaiCompatible.ts:322](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L322)

## Properties

### modelId

> **modelId**: `string`

Defined in: [types/openaiCompatible.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L319)
Defined in: [types/openaiCompatible.ts:323](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L323)

---

### messages

> **messages**: [`OpenAICompatChatMessage`](OpenAICompatChatMessage.md)[]

Defined in: [types/openaiCompatible.ts:320](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L320)
Defined in: [types/openaiCompatible.ts:324](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L324)

---

### options

> **options**: `object`

Defined in: [types/openaiCompatible.ts:321](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L321)
Defined in: [types/openaiCompatible.ts:325](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L325)

#### maxTokens?

Expand Down Expand Up @@ -78,28 +78,28 @@ explicit channel for non-OpenAI knobs (e.g. NVIDIA NIM's `top_k` /

> `optional` **tools?**: [`OpenAICompatChatTool`](OpenAICompatChatTool.md)[]

Defined in: [types/openaiCompatible.ts:338](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L338)
Defined in: [types/openaiCompatible.ts:342](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L342)

---

### toolChoice?

> `optional` **toolChoice?**: [`OpenAICompatToolChoiceWire`](OpenAICompatToolChoiceWire.md)

Defined in: [types/openaiCompatible.ts:339](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L339)
Defined in: [types/openaiCompatible.ts:343](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L343)

---

### streaming

> **streaming**: `boolean`

Defined in: [types/openaiCompatible.ts:340](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L340)
Defined in: [types/openaiCompatible.ts:344](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L344)

---

### responseFormat?

> `optional` **responseFormat?**: [`OpenAICompatResponseFormat`](OpenAICompatResponseFormat.md)

Defined in: [types/openaiCompatible.ts:341](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L341)
Defined in: [types/openaiCompatible.ts:345](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L345)
20 changes: 20 additions & 0 deletions docs/api/type-aliases/OpenAICompatSSEResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,23 @@ Defined in: [types/openaiCompatible.ts:260](https://github.com/juspay/neurolink/
> `optional` **usage?**: [`OpenAICompatUsage`](OpenAICompatUsage.md)

Defined in: [types/openaiCompatible.ts:267](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L267)

---

### id?

> `optional` **id?**: `string`

Defined in: [types/openaiCompatible.ts:269](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L269)

Response id from the first stream chunk that carried one.

---

### model?

> `optional` **model?**: `string`

Defined in: [types/openaiCompatible.ts:271](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L271)

Served model from the first stream chunk that carried one.
6 changes: 3 additions & 3 deletions docs/api/type-aliases/OpenAICompatStreamChunk.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@

> **OpenAICompatStreamChunk** = `object`

Defined in: [types/openaiCompatible.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L275)
Defined in: [types/openaiCompatible.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L279)

## Properties

### content

> **content**: `string`

Defined in: [types/openaiCompatible.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L275)
Defined in: [types/openaiCompatible.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L279)

---

### reasoning?

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

Defined in: [types/openaiCompatible.ts:275](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L275)
Defined in: [types/openaiCompatible.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L279)
6 changes: 3 additions & 3 deletions docs/api/type-aliases/OpenAICompatStreamLifecycleListeners.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **OpenAICompatStreamLifecycleListeners** = `object`

Defined in: [types/openaiCompatible.ts:350](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L350)
Defined in: [types/openaiCompatible.ts:354](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L354)

Per-stream lifecycle listeners returned from an OpenAIChatCompletionsProvider
subclass's `onStreamStart` hook. Every property is optional — provide only
Expand All @@ -21,7 +21,7 @@ the deferred analytics promises.

> `optional` **onUsage?**: (`usage`) => `void`

Defined in: [types/openaiCompatible.ts:357](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L357)
Defined in: [types/openaiCompatible.ts:361](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L361)

Fired once the deferred usage promise resolves with the final aggregated
token counts. promptTokens is the UNCACHED remainder; cacheReadTokens
Expand All @@ -44,7 +44,7 @@ reasoningTokens is a subset of completionTokens.

> `optional` **onFinish?**: (`reason`, `capturedError?`) => `void`

Defined in: [types/openaiCompatible.ts:363](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L363)
Defined in: [types/openaiCompatible.ts:367](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L367)

Fired once the deferred finish promise resolves. `reason` is "stop",
"length", "tool-calls", "content-filter", or "error". When the loop
Expand Down
38 changes: 19 additions & 19 deletions docs/api/type-aliases/StreamLoopArgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,95 +8,95 @@

> **StreamLoopArgs** = `object`

Defined in: [types/openaiCompatible.ts:291](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L291)
Defined in: [types/openaiCompatible.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L295)

## Properties

### maxSteps

> **maxSteps**: `number`

Defined in: [types/openaiCompatible.ts:292](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L292)
Defined in: [types/openaiCompatible.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L296)

---

### modelId

> **modelId**: `string`

Defined in: [types/openaiCompatible.ts:293](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L293)
Defined in: [types/openaiCompatible.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L297)

---

### url

> **url**: `string`

Defined in: [types/openaiCompatible.ts:294](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L294)
Defined in: [types/openaiCompatible.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L298)

---

### fetchImpl

> **fetchImpl**: _typeof_ `fetch`

Defined in: [types/openaiCompatible.ts:295](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L295)
Defined in: [types/openaiCompatible.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L299)

---

### abortSignal

> **abortSignal**: `AbortSignal` \| `undefined`

Defined in: [types/openaiCompatible.ts:296](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L296)
Defined in: [types/openaiCompatible.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L300)

---

### options

> **options**: [`StreamOptions`](StreamOptions.md)

Defined in: [types/openaiCompatible.ts:297](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L297)
Defined in: [types/openaiCompatible.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L301)

---

### conversation

> **conversation**: [`OpenAICompatChatMessage`](OpenAICompatChatMessage.md)[]

Defined in: [types/openaiCompatible.ts:298](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L298)
Defined in: [types/openaiCompatible.ts:302](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L302)

---

### openAITools

> **openAITools**: [`OpenAICompatChatTool`](OpenAICompatChatTool.md)[] \| `undefined`

Defined in: [types/openaiCompatible.ts:299](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L299)
Defined in: [types/openaiCompatible.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L303)

---

### openAIToolChoice

> **openAIToolChoice**: [`OpenAICompatToolChoiceWire`](OpenAICompatToolChoiceWire.md) \| `undefined`

Defined in: [types/openaiCompatible.ts:300](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L300)
Defined in: [types/openaiCompatible.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L304)

---

### toolsRecord

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

Defined in: [types/openaiCompatible.ts:301](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L301)
Defined in: [types/openaiCompatible.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L305)

---

### toolNameFromWire?

> `optional` **toolNameFromWire?**: `Map`\<`string`, `string`\>

Defined in: [types/openaiCompatible.ts:303](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L303)
Defined in: [types/openaiCompatible.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L307)

Wire → registered tool-name map when sanitization was needed (see buildWireToolNameMaps).

Expand All @@ -106,31 +106,31 @@ Wire → registered tool-name map when sanitization was needed (see buildWireToo

> **emitter**: `TypedEventEmitter`\<[`NeuroLinkEvents`](NeuroLinkEvents.md)\> \| `undefined`

Defined in: [types/openaiCompatible.ts:304](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L304)
Defined in: [types/openaiCompatible.ts:308](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L308)

---

### toolsUsed

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

Defined in: [types/openaiCompatible.ts:305](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L305)
Defined in: [types/openaiCompatible.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L309)

---

### toolExecutionSummaries

> **toolExecutionSummaries**: [`ToolExecutionSummaryInternal`](ToolExecutionSummaryInternal.md)[]

Defined in: [types/openaiCompatible.ts:306](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L306)
Defined in: [types/openaiCompatible.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L310)

---

### pushChunk

> **pushChunk**: (`chunk`) => `void`

Defined in: [types/openaiCompatible.ts:307](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L307)
Defined in: [types/openaiCompatible.ts:311](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L311)

#### Parameters

Expand All @@ -148,7 +148,7 @@ Defined in: [types/openaiCompatible.ts:307](https://github.com/juspay/neurolink/

> **closeChannel**: () => `void`

Defined in: [types/openaiCompatible.ts:309](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L309)
Defined in: [types/openaiCompatible.ts:313](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L313)

Signals the channel that no further chunks will arrive (success or error path alike).

Expand All @@ -162,7 +162,7 @@ Signals the channel that no further chunks will arrive (success or error path al

> **resolveUsage**: (`u`) => `void`

Defined in: [types/openaiCompatible.ts:310](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L310)
Defined in: [types/openaiCompatible.ts:314](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L314)

#### Parameters

Expand Down Expand Up @@ -190,7 +190,7 @@ Defined in: [types/openaiCompatible.ts:310](https://github.com/juspay/neurolink/

> **resolveFinish**: (`reason`) => `void`

Defined in: [types/openaiCompatible.ts:315](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L315)
Defined in: [types/openaiCompatible.ts:319](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L319)

#### Parameters

Expand Down
16 changes: 8 additions & 8 deletions docs/api/type-aliases/ToolExecutionSummaryInternal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,60 +8,60 @@

> **ToolExecutionSummaryInternal** = `object`

Defined in: [types/openaiCompatible.ts:279](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L279)
Defined in: [types/openaiCompatible.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L283)

## Properties

### toolCallId

> **toolCallId**: `string`

Defined in: [types/openaiCompatible.ts:280](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L280)
Defined in: [types/openaiCompatible.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L284)

---

### toolName

> **toolName**: `string`

Defined in: [types/openaiCompatible.ts:281](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L281)
Defined in: [types/openaiCompatible.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L285)

---

### input

> **input**: `unknown`

Defined in: [types/openaiCompatible.ts:282](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L282)
Defined in: [types/openaiCompatible.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L286)

---

### output?

> `optional` **output?**: `unknown`

Defined in: [types/openaiCompatible.ts:283](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L283)
Defined in: [types/openaiCompatible.ts:287](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L287)

---

### error?

> `optional` **error?**: `string`

Defined in: [types/openaiCompatible.ts:284](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L284)
Defined in: [types/openaiCompatible.ts:288](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L288)

---

### startTime

> **startTime**: `Date`

Defined in: [types/openaiCompatible.ts:285](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L285)
Defined in: [types/openaiCompatible.ts:289](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L289)

---

### endTime

> **endTime**: `Date`

Defined in: [types/openaiCompatible.ts:286](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L286)
Defined in: [types/openaiCompatible.ts:290](https://github.com/juspay/neurolink/blob/release/src/lib/types/openaiCompatible.ts#L290)
Loading
Loading