GetCompletionsOptions interface
The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
- Extends
Properties
| best |
A value that controls how many completions will be internally generated prior to response formulation. When used together with n, best_of controls the number of candidate completions and must be greater than n. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. |
| echo | A value specifying whether completions responses should include input prompts as prefixes to their generated output. |
| frequency |
A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. |
| logit |
A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model. |
| logprobs | A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response. |
| max |
The maximum number of tokens to generate. |
| n | The number of completions choices that should be generated per provided prompt as part of an overall completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop. |
| presence |
A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. |
| stop | A collection of textual sequences that will end completions generation. |
| temperature | The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. |
| topP | An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. |
| user | An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
bestOf
A value that controls how many completions will be internally generated prior to response formulation. When used together with n, best_of controls the number of candidate completions and must be greater than n. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop.
bestOf?: numberProperty Value
number
echo
A value specifying whether completions responses should include input prompts as prefixes to their generated output.
echo?: booleanProperty Value
boolean
frequencyPenalty
A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim.
frequencyPenalty?: numberProperty Value
number
logitBias
A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response. Token IDs are computed via external tokenizer tools, while bias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to a full ban or exclusive selection of a token, respectively. The exact behavior of a given bias score varies by model.
logitBias?: Record<string, number>Property Value
Record<string, number>
logprobs
A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response.
logprobs?: numberProperty Value
number
maxTokens
The maximum number of tokens to generate.
maxTokens?: numberProperty Value
number
n
The number of completions choices that should be generated per provided prompt as part of an overall completions response. Because this setting can generate many completions, it may quickly consume your token quota. Use carefully and ensure reasonable settings for max_tokens and stop.
n?: numberProperty Value
number
presencePenalty
A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics.
presencePenalty?: numberProperty Value
number
stop
A collection of textual sequences that will end completions generation.
stop?: string[]Property Value
string[]
temperature
The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.
temperature?: numberProperty Value
number
topP
An alternative to sampling with temperature called nucleus sampling. This value causes the model to consider the results of tokens with the provided probability mass. As an example, a value of 0.15 will cause only the tokens comprising the top 15% of probability mass to be considered. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.
topP?: numberProperty Value
number
user
An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.
user?: stringProperty Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallbackProperty Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From OperationOptions.tracingOptions
Azure SDK for JavaScript