@sap-ai-sdk/foundation-models/dist/azure-openai/client/inference/schema/create-chat-completion-stream-response.d.ts

SAP Cloud SDK for AI is the official Software Development Kit (SDK) for **SAP AI Core**, **SAP Generative AI Hub**, and **Orchestration Service**.

import type { AzureOpenAiChatCompletionStreamResponseDelta } from './chat-completion-stream-response-delta.js';
import type { AzureOpenAiChatCompletionTokenLogprob } from './chat-completion-token-logprob.js';
/**
 * Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
 */
export type AzureOpenAiCreateChatCompletionStreamResponse = {
    /**
     * A unique identifier for the chat completion. Each chunk has the same ID.
     */
    id: string;
    /**
     * A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.
     *
     */
    choices: ({
        delta: AzureOpenAiChatCompletionStreamResponseDelta;
        /**
         * Log probability information for the choice.
         */
        logprobs?: ({
            /**
             * A list of message content tokens with log probability information.
             */
            content: AzureOpenAiChatCompletionTokenLogprob[] | null;
            /**
             * A list of message refusal tokens with log probability information.
             */
            refusal: AzureOpenAiChatCompletionTokenLogprob[] | null;
        } & Record<string, any>) | null;
        /**
         * The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,
         * `length` if the maximum number of tokens specified in the request was reached,
         * `content_filter` if content was omitted due to a flag from our content filters,
         * `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.
         *
         */
        finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call' | null;
        /**
         * The index of the choice in the list of choices.
         */
        index: number;
    } & Record<string, any>)[];
    /**
     * The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
     */
    created: number;
    /**
     * The model to generate the completion.
     */
    model: string;
    /**
     * This fingerprint represents the backend configuration that the model runs with.
     * Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
     *
     */
    system_fingerprint?: string;
    /**
     * The object type, which is always `chat.completion.chunk`.
     */
    object: 'chat.completion.chunk';
} & Record<string, any>;
//# sourceMappingURL=create-chat-completion-stream-response.d.ts.map