Aller au contenu principal
Version : 21 R3 BETA

OpenAIChatCompletionsStreamResult

Hérite de

Propriétés

PropriétéTypeDescription
dataObjectContient le flux de données envoyées par le serveur.

Propriétés calculées

PropriétéTypeDescription
choiceOpenAIChoiceRenvoie une donnée choice, avec un message delta.
choicesCollectionRenvoie une collection de données OpenAIChoice, avec des messages delta.

Overridden properties

PropriétéTypeDescription
successBooleanRetourne True si le flux de données a été décodé avec succès en tant qu'objet.
terminatedBooleanUn booléen indiquant si la requête HTTP a été close, c'est-à-dire si onTerminate a été appelé.
usageObjectReturns 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:

ChampTypeDescription
prompt_tokensIntegerNumber of tokens in the prompt.
completion_tokensIntegerNumber of tokens in the completion.
total_tokensIntegerTotal tokens used (prompt + completion).
prompt_tokens_detailsObjectBreakdown of prompt tokens (optional).
completion_tokens_detailsObjectBreakdown 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.