Class AzureOpenAiChatCompletionStream<Item>

Chat completion stream containing post-processing functions.

Type Parameters

Item

Hierarchy (View Summary)

SseStream<Item>
- AzureOpenAiChatCompletionStream

Index

Constructors

constructor

new AzureOpenAiChatCompletionStream<Item>(
iterator: () => AsyncIterator<Item>,
controller: AbortController,
): AzureOpenAiChatCompletionStream<Item>
Type Parameters
- Item
Parameters
- iterator: () => AsyncIterator<Item>
- controller: AbortController
Returns AzureOpenAiChatCompletionStream<Item>
Overrides SseStream.constructor
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:43

Properties

controller

controller: AbortController

iterator

iterator: () => AsyncIterator<Item>

Methods

_pipe

_pipe<TReturn>(
    processFn: (
        stream: AzureOpenAiChatCompletionStream<Item>,
        response?: AzureOpenAiChatCompletionStreamResponse<any>,
    ) => AsyncIterator<TReturn>,
    response?: AzureOpenAiChatCompletionStreamResponse<any>,
): AzureOpenAiChatCompletionStream<TReturn>
Internal
Pipe the stream through a processing function.
Type Parameters
- TReturn
Parameters
- processFn: (
  stream: AzureOpenAiChatCompletionStream<Item>,
  response?: AzureOpenAiChatCompletionStreamResponse<any>,
  ) => AsyncIterator<TReturn>
  The function to process the input stream.
- Optionalresponse: AzureOpenAiChatCompletionStreamResponse<any>
  The AzureOpenAiChatCompletionStreamResponse object for process function to store finish reason, token usage, etc.
Returns AzureOpenAiChatCompletionStream<TReturn>
The output stream containing processed items.
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:51

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Item>
Returns AsyncIterator<Item>
Inherited from SseStream.[asyncIterator]
- Defined in packages/core/dist/stream/sse-stream.d.ts:11

toContentStream

toContentStream(
    this: AzureOpenAiChatCompletionStream<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
    choiceIndex?: number,
): AzureOpenAiChatCompletionStream<string>
Parameters
- this: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
- OptionalchoiceIndex: number
Returns AzureOpenAiChatCompletionStream<string>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:52

toReadableStream

toReadableStream(): ReadableStream<Uint8Array<ArrayBufferLike>>
Converts this stream to a newline-delimited JSON ReadableStream.

Returns ReadableStream<Uint8Array<ArrayBufferLike>>
A ReadableStream of UTF-8 encoded NDJSON bytes.
Inherited from SseStream.toReadableStream
- Defined in packages/core/dist/stream/sse-stream.d.ts:16

`Static`_create

_create(
    response: HttpResponse,
    controller: AbortController,
): AzureOpenAiChatCompletionStream<
    AzureOpenAiCreateChatCompletionStreamResponse,
>
Internal
Create a chat completion stream based on the http response.
Parameters
- response: HttpResponse
  Http response.
- controller: AbortController
Returns AzureOpenAiChatCompletionStream<AzureOpenAiCreateChatCompletionStreamResponse>
Chat completion stream.
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:17

`Static`_processChunk

_processChunk(
    stream: AzureOpenAiChatCompletionStream<
        AzureOpenAiCreateChatCompletionStreamResponse,
    >,
): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
Internal
Wrap raw chunk data with chunk response class to provide helper functions.
Parameters
- stream: AzureOpenAiChatCompletionStream<AzureOpenAiCreateChatCompletionStreamResponse>
  Chat completion stream.
Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:23

`Static`_processContentStream

_processContentStream(
    stream: AzureOpenAiChatCompletionStream<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
    choiceIndex?: number,
): AsyncGenerator<string>
Internal
Transform a stream of chunks into a stream of content strings.
Parameters
- stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
  Chat completion stream.
- OptionalchoiceIndex: number
  The index of the choice to parse.
Returns AsyncGenerator<string>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:42

`Static`_processFinishReason

_processFinishReason(
    stream: AzureOpenAiChatCompletionStream<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
    response?: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
Internal
Parameters
- stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
- Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
  AzureOpenAiChatCompletionStreamChunkResponse,
  >
Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:31

`Static`_processTokenUsage

_processTokenUsage(
    stream: AzureOpenAiChatCompletionStream<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
    response?: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
Internal
Parameters
- stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
- Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
  AzureOpenAiChatCompletionStreamChunkResponse,
  >
Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:35

`Static`_processToolCalls

_processToolCalls(
    stream: AzureOpenAiChatCompletionStream<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
    response?: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >,
): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
Internal
Parameters
- stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
- Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
  AzureOpenAiChatCompletionStreamChunkResponse,
  >
Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-chat-completion-stream.d.ts:27

`Protected` `Static`transformToSseStream

transformToSseStream<Item>(
response: HttpResponse,
controller: AbortController,
): SseStream<Item>
Type Parameters
- Item
Parameters
- response: HttpResponse
- controller: AbortController
Returns SseStream<Item>
Inherited from SseStream.transformToSseStream
- Defined in packages/core/dist/stream/sse-stream.d.ts:8

Class AzureOpenAiChatCompletionStream<Item>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AzureOpenAiChatCompletionStream<Item>

Properties

controller

iterator

Methods

_pipe

Type Parameters

Parameters

Returns AzureOpenAiChatCompletionStream<TReturn>

[asyncIterator]

Returns AsyncIterator<Item>

toContentStream

Parameters

Returns AzureOpenAiChatCompletionStream<string>

toReadableStream

Returns ReadableStream<Uint8Array<ArrayBufferLike>>

Static_create

Parameters

Returns AzureOpenAiChatCompletionStream<AzureOpenAiCreateChatCompletionStreamResponse>

Static_processChunk

Parameters

Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Static_processContentStream

Parameters

Returns AsyncGenerator<string>

Static_processFinishReason

Parameters

Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Static_processTokenUsage

Parameters

Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Static_processToolCalls

Parameters

Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Protected StatictransformToSseStream

Type Parameters

Parameters

Returns SseStream<Item>

Settings

On This Page

`Static`_create

`Static`_processChunk

`Static`_processContentStream

`Static`_processFinishReason

`Static`_processTokenUsage

`Static`_processToolCalls

`Protected` `Static`transformToSseStream