Class AzureOpenAiChatCompletionStream<Item>

constructor

• new AzureOpenAiChatCompletionStream<Item>(
      iterator: () => AsyncIterator<Item>,
      controller: AbortController,
  ): AzureOpenAiChatCompletionStream<Item>

  Type Parameters

  • Item

  Parameters

  • iterator: () => AsyncIterator<Item>
  • controller: AbortController

  Returns AzureOpenAiChatCompletionStream<Item>

iterator

_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.

toContentStream

• toContentStream(
      this: AzureOpenAiChatCompletionStream<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
      choiceIndex?: number,
  ): AzureOpenAiChatCompletionStream<string>

  Parameters

  • this: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
  • OptionalchoiceIndex: number

  Returns AzureOpenAiChatCompletionStream<string>

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.

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>

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.

    Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.

  Returns AsyncGenerator<string>

Static_processFinishReason

• _processFinishReason(
      stream: AzureOpenAiChatCompletionStream<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
      response?: AzureOpenAiChatCompletionStreamResponse<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
  ): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
  Internal

  Parameters

  • stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
  • Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >

  Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Static_processTokenUsage

• _processTokenUsage(
      stream: AzureOpenAiChatCompletionStream<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
      response?: AzureOpenAiChatCompletionStreamResponse<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
  ): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
  Internal

  Parameters

  • stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
  • Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >

  Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>

Static_processToolCalls

• _processToolCalls(
      stream: AzureOpenAiChatCompletionStream<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
      response?: AzureOpenAiChatCompletionStreamResponse<
          AzureOpenAiChatCompletionStreamChunkResponse,
      >,
  ): AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>
  Internal

  Parameters

  • stream: AzureOpenAiChatCompletionStream<AzureOpenAiChatCompletionStreamChunkResponse>
  • Optionalresponse: AzureOpenAiChatCompletionStreamResponse<
        AzureOpenAiChatCompletionStreamChunkResponse,
    >

  Returns AsyncGenerator<AzureOpenAiChatCompletionStreamChunkResponse>