post/openai/deployments/{Deployment_Name}/chat/completions/{api_version}

Request

  • Base URL: https://api.openai.com/v1
  • URL: https://api.openai.com/v1/openai/deployments/{Deployment_Name}/chat/completions/{api_version}
  • Auth: API key in header Api-Key

Path parameters

api_versionstring required

The API version to use for this operation. This follows the YYYY-MM-DD format.

Request body

modelstring

ID of the model to use.

streamboolean

If set, partial message deltas will be sent. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message

temperaturenumber

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.

top_pnumber

An alternative to sampling with temperature, called nucleus sampling, where the assistant 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.

ninteger

How many chat completion choices to generate for each input message.

max_tokensinteger

The maximum number of tokens to generate by the assistant.

presence_penaltynumber

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.

frequency_penaltynumber

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.

logit_biasobject

Modify the likelihood of specified tokens appearing in the completion.

Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. 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.

userstring

A unique identifier representing end-user.

Response

Success

idstring

The ID of the response.

objectstring

Object type. Always is "chat.completion" for non-streaming.

createdinteger

The response timestamp. The time in seconds since the epoch.

Changes

No recorded changes to this operation across all 1 revision of this API.