Creates a completion for the provided prompt and parameters.
POST /completions
Authorizations
Request Body required
object
Generates best_of
completions server-side and returns the “best” (the one with the highest log probability per token). Results cannot be streamed.
When used with n
, best_of
controls the number of candidate completions and n
specifies how many to return – best_of
must be greater than n
.
Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens
and stop
.
Echo back the prompt in addition to the completion
Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.
See more information about frequency and presence penalties.
Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
As an example, you can pass {"50256": -100}
to prevent the <|endoftext|> token from being generated.
object
Include the log probabilities on the logprobs
most likely output tokens, as well the chosen tokens. For example, if logprobs
is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob
of the sampled token, so there may be up to logprobs+1
elements in the response.
The maximum value for logprobs
is 5.
The maximum number of tokens that can be generated in the completion.
The token count of your prompt plus max_tokens
cannot exceed the model’s context length. Example Python code for counting tokens.
How many completions to generate for each prompt.
Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens
and stop
.
Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics.
See more information about frequency and presence penalties.
If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed
and parameters should return the same result.
Determinism is not guaranteed, and you should refer to the system_fingerprint
response parameter to monitor changes in the backend.
Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE]
message. Example Python code.
Options for streaming response. Only set this when you set stream: true
.
object
If set, an additional chunk will be streamed before the data: [DONE]
message. The usage
field on this chunk shows the token usage statistics for the entire request, and the choices
field will always be an empty array. All other chunks will also include a usage
field, but with a null value.
The suffix that comes after a completion of inserted text.
This parameter is only supported for gpt-3.5-turbo-instruct
.
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
We generally recommend altering this or top_p
but not both.
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature
but not both.
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Responses
200
OK
Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).
object
A unique identifier for the completion.
The list of completion choices the model generated for the input prompt.
object
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,
or content_filter
if content was omitted due to a flag from our content filters.
object
object
The Unix timestamp (in seconds) of when the completion was created.
The model used for completion.
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.
The object type, which is always “text_completion”
Usage statistics for the completion request.
object
Number of tokens in the generated completion.
Number of tokens in the prompt.
Total number of tokens used in the request (prompt + completion).
Breakdown of tokens used in a completion.
object
Audio input tokens generated by the model.
Tokens generated by the model for reasoning.
Breakdown of tokens used in the prompt.
object
Audio input tokens present in the prompt.
Cached tokens present in the prompt.