SAP AI SDK for JavaScript - v2.9.0
    Preparing search index...

    Class AzureOpenAiChatCompletionStreamResponse<T>

    Azure OpenAI chat completion stream response.

    Type Parameters

    • T
    Index

    Constructors

    constructor

    Accessors

    rawResponse stream

    Methods

    _getFinishReasons _getToolCallsAccumulators _setFinishReasons _setTokenUsage _setToolCalls getFinishReason getRequestId getTokenUsage getToolCalls

    Constructors

    • Type Parameters

      • T

      Returns AzureOpenAiChatCompletionStreamResponse<T>

      Since v2.9.0. Provide an HttpResponse parameter when constructing AzureOpenAiChatCompletionStreamResponse. This constructor overload will be removed in v3.0.0. Creates an Azure OpenAI chat completion stream response.

    • Creates an Azure OpenAI chat completion stream response.

      Type Parameters

      • T

      Parameters

      • rawResponse: HttpResponse

        The raw HTTP response. SSE data is not part of the immediate response.

      Returns AzureOpenAiChatCompletionStreamResponse<T>

    Accessors

    • get rawResponse(): HttpResponse

      Gets the raw HTTP response. SSE data is not part of the immediate response.

      Returns HttpResponse

      The raw HTTP response.

      When constructed without a raw response parameter (deprecated).

    Methods

    _getFinishReasons

    • _getFinishReasons(): Map<
          number,
          | "stop"
          | "length"
          | "tool_calls"
          | "content_filter"
          | "function_call"
          | null,
      >
      Internal

      Returns Map<
          number,
          | "stop"
          | "length"
          | "tool_calls"
          | "content_filter"
          | "function_call"
          | null,
      >

    _getToolCallsAccumulators

    • _getToolCallsAccumulators(): Map<number, Map<number, ToolCallAccumulator>>
      Internal

      Returns Map<number, Map<number, ToolCallAccumulator>>

    _setFinishReasons

    • _setFinishReasons(
          finishReasons: Map<
              number,
              | "stop"
              | "length"
              | "tool_calls"
              | "content_filter"
              | "function_call"
              | null,
          >,
      ): void
      Internal

      Parameters

      • finishReasons: Map<
            number,
            | "stop"
            | "length"
            | "tool_calls"
            | "content_filter"
            | "function_call"
            | null,
        >

      Returns void

    _setTokenUsage

    • _setTokenUsage(usage: AzureOpenAiCompletionUsage): void
      Internal

      Parameters

      • usage: AzureOpenAiCompletionUsage

      Returns void

    _setToolCalls

    • _setToolCalls(
          choiceIndex: number,
          toolCalls: AzureOpenAiChatCompletionMessageToolCalls,
      ): void
      Internal

      Parameters

      • choiceIndex: number
      • toolCalls: AzureOpenAiChatCompletionMessageToolCalls

      Returns void

    • Parameters

      • OptionalchoiceIndex: number

      Returns
          | "stop"
          | "length"
          | "tool_calls"
          | "content_filter"
          | "function_call"
          | null
          | undefined

    • Gets the request ID from the response headers.

      Returns string | undefined

      The request ID, or undefined if the header is not present.

    • Returns AzureOpenAiCompletionUsage | undefined

    • Gets the tool calls for a specific choice index.

      Parameters

      • OptionalchoiceIndex: number

        The index of the choice to get the tool calls for.

      Returns AzureOpenAiChatCompletionMessageToolCalls | undefined

      The tool calls for the specified choice index.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods