AZazure

Creates a completion for the chat message

Creates a completion for the chat message

post/chat/completions

Request

  • The document declares no server URL.
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or API key in query parameter subscription-key

Query parameters

api-versionstring required

api version

Example:2023-05-15

Request body

temperaturenumber nullable

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.

top_pnumber nullable

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.

ninteger nullable

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

streamboolean nullable

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

max_tokensinteger

The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).

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 nullable

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 your end-user, which can help Azure OpenAI to monitor and detect abuse.

Example request

{
  "temperature": 1,
  "top_p": 1,
  "n": 1,
  "user": "user-1234"
}

Response

OK

idstring required
objectstring required
createdinteger required
modelstring required

Changes

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