ChatCompletions interface

Package:

@azure/openai

Representation of the response data from a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

Properties

choices	The collection of completions choices associated with this completions response. Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.
created	The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
id	A unique identifier associated with this chat completions response.
promptFilterResults	Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.
systemFingerprint	Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.
usage	Usage information for tokens processed and generated as part of this completions operation.

Property Details

choices

The collection of completions choices associated with this completions response. Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.

choices: ChatChoice[]

Property Value

ChatChoice[]

created

The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.

created: Date

Property Value

Date

id

A unique identifier associated with this chat completions response.

id: string

Property Value

string

promptFilterResults

Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.

promptFilterResults?: ContentFilterResultsForPrompt[]

Property Value

ContentFilterResultsForPrompt[]

systemFingerprint

Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

systemFingerprint?: string

Property Value

string

usage

Usage information for tokens processed and generated as part of this completions operation.

usage?: CompletionsUsage

Property Value

CompletionsUsage