OpenAIChatCompletionsStreamResult.md

OpenAIChatCompletionsStreamResult

Inherits

• OpenAIResult

Properties

Property	Type	Description
data	Object	Contains the stream data sent by the server.

Computed Properties

Property	Type	Description
choice	OpenAIChoice	Returns a choice data, with a delta message.
choices	Collection	Returns a collection of OpenAIChoice data, with delta messages.

Overridden properties

Property	Type	Description
success	Boolean	Returns True if the streaming data was successfully decoded as an object.
terminated	Boolean	A Boolean indicating whether the HTTP request was terminated. ie onTerminate called.
usage	Object	Returns token usage information from the stream data (only available in the final chunk when stream_options.include_usage is set to True).

usage

The usage property returns an object containing token usage information, available only in the final streaming chunk when enabled via stream_options.include_usage: True in the request parameters.

The structure is the same as OpenAIChatCompletionsResult:

Field	Type	Description
prompt_tokens	Integer	Number of tokens in the prompt.
completion_tokens	Integer	Number of tokens in the completion.
total_tokens	Integer	Total tokens used (prompt + completion).
prompt_tokens_details	Object	Breakdown of prompt tokens (optional).
completion_tokens_details	Object	Breakdown of completion tokens (optional).

Note: To receive usage information in streaming responses, you must set stream_options: {include_usage: True} in your request parameters. See OpenAIChatCompletionsParameters for details.