Azure OpenAI API (stable:2023-05-15)

2025/03/21 • 2 updated methods

GetChatCompletions (updated)
Description :  Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetChatCompletions",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "usage",
          "Required": {
            "new": false,
            "old": true
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /deployments/{deploymentId}/chat/completions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. ,
Required: True ,
}
{
messages:
{
Description: The collection of context messages associated with this chat completions request. Typical usage begins with a chat message for the System role that provides instructions for the behavior of the assistant, followed by alternating messages between the User and Assistant roles. ,
Required: True ,
}
[
{
role:
{
Description: The chat role associated with this message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
max_tokens:
{
Description: 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). This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
logit_bias:
{
Description: 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. ,
Required: False ,
}
object ,
user:
{
Description: An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. ,
Required: False ,
}
string ,
n:
{
Description: The number of chat completions choices that should be generated for a chat 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. ,
Format: int32 ,
Required: False ,
}
integer ,
stop:
{
Description: A collection of textual sequences that will end completions generation. ,
Required: False ,
}
[
string ,
]
,
presence_penalty:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
frequency_penalty:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
stream:
{
Description: A value indicating whether chat completions should be streamed for this request. ,
Required: False ,
}
boolean ,
model:
{
Description: The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: A unique identifier associated with this chat completions response. ,
Required: True ,
}
string ,
created:
{
Description: 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. ,
Format: unixtime ,
Required: True ,
}
integer ,
choices:
{
Description: 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. ,
Required: True ,
}
[
{
message:
{
Description: The chat message for a given chat completions prompt. ,
Required: False ,
}
{
role:
{
Description: The chat role associated with the message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the message. ,
Required: True ,
}
string ,
}
,
index:
{
Description: The ordered index associated with this chat completions choice. ,
Format: int32 ,
Required: True ,
}
integer ,
finish_reason:
{
Description: The reason that this chat completions choice completed its generated. ,
Enum:
{
stop: Completions ended normally and reached its end of token generation. ,
length: Completions exhausted available token limits before generation could complete. ,
content_filter: Completions generated a response that was identified as potentially sensitive per content moderation policies. ,
}
,
Required: True ,
}
enum ,
delta:
{
Description: The delta message content for a streaming response. ,
Required: False ,
}
{
role:
{
Description: The chat role associated with the message. ,
Enum:
{
system: The role that instructs or sets the behavior of the assistant. ,
assistant: The role that provides responses to system-instructed, user-prompted input. ,
user: The role that provides input for chat completions. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the message. ,
Required: True ,
}
string ,
}
,
}
,
]
,
model:
{
Description: The model name used for this completions request. ,
Required: False ,
}
string ,
usage:
{
Description: Usage information for tokens processed and generated as part of this completions operation. ,
Required: False ,
}
{
completion_tokens:
{
Description: The number of tokens generated across all completions emissions. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: The number of tokens in the provided prompts for the completions request. ,
Format: int32 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: The total number of tokens processed for the completions request and response. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCompletions (updated)
Description :  Gets completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetCompletions",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "usage",
          "Required": {
            "new": false,
            "old": true
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /deployments/{deploymentId}/completions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentId:
{
Description: Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request. ,
Required: True ,
}
string ,
body:
{
Description: 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. ,
Required: True ,
}
{
prompt:
{
Description: The prompts to generate completions from. ,
Required: True ,
}
[
string ,
]
,
max_tokens:
{
Description: The maximum number of tokens to generate. ,
Format: int32 ,
Required: False ,
}
integer ,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
logit_bias:
{
Description: 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. ,
Required: False ,
}
object ,
user:
{
Description: An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes. ,
Required: False ,
}
string ,
n:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
logprobs:
{
Description: A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response. ,
Format: int32 ,
Required: False ,
}
integer ,
suffix:
{
Description: The suffix that comes after a completion of inserted text ,
Required: False ,
}
string ,
echo:
{
Description: A value specifying whether completions responses should include input prompts as prefixes to their generated output. ,
Required: False ,
}
boolean ,
stop:
{
Description: A collection of textual sequences that will end completions generation. ,
Required: False ,
}
[
string ,
]
,
presence_penalty:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
frequency_penalty:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
best_of:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
stream:
{
Description: A value indicating whether chat completions should be streamed for this request. ,
Required: False ,
}
boolean ,
model:
{
Description: The model name to provide as part of this completions request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: A unique identifier associated with this completions response. ,
Required: True ,
}
string ,
created:
{
Description: 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. ,
Format: unixtime ,
Required: True ,
}
integer ,
choices:
{
Description: 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. ,
Required: True ,
}
[
{
text:
{
Description: The generated text for a given completions prompt. ,
Required: True ,
}
string ,
index:
{
Description: The ordered index associated with this completions choice. ,
Format: int32 ,
Required: True ,
}
integer ,
logprobs:
{
Description: The log probabilities model for tokens associated with this completions choice. ,
Required: True ,
}
object ,
finish_reason:
{
Description: Reason for finishing ,
Enum:
{
stop: Completions ended normally and reached its end of token generation. ,
length: Completions exhausted available token limits before generation could complete. ,
content_filter: Completions generated a response that was identified as potentially sensitive per content moderation policies. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
usage:
{
Description: Usage information for tokens processed and generated as part of this completions operation. ,
Required: False ,
}
{
completion_tokens:
{
Description: The number of tokens generated across all completions emissions. ,
Format: int32 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: The number of tokens in the provided prompts for the completions request. ,
Format: int32 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: The total number of tokens processed for the completions request and response. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}