Microsoft Azure · Schema

CreateCompletionRequest

Request body for creating a text completion.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
prompt string The prompt(s) to generate completions for.
max_tokens integer The maximum number of tokens that can be generated.
temperature number Sampling temperature to use.
top_p number Nucleus sampling parameter.
n integer How many completions to generate for each prompt.
stream boolean Whether to stream back partial progress.
stop string Up to 4 sequences where the API will stop generating further tokens.
presence_penalty number Penalizes new tokens based on whether they appear in the text so far.
frequency_penalty number Penalizes new tokens based on their existing frequency in the text.
user string A unique identifier representing your end-user.
View JSON Schema on GitHub

JSON Schema

azure-openai-service-create-completion-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateCompletionRequest",
  "type": "object",
  "description": "Request body for creating a text completion.",
  "properties": {
    "prompt": {
      "type": "string",
      "description": "The prompt(s) to generate completions for."
    },
    "max_tokens": {
      "type": "integer",
      "description": "The maximum number of tokens that can be generated."
    },
    "temperature": {
      "type": "number",
      "description": "Sampling temperature to use."
    },
    "top_p": {
      "type": "number",
      "description": "Nucleus sampling parameter."
    },
    "n": {
      "type": "integer",
      "description": "How many completions to generate for each prompt."
    },
    "stream": {
      "type": "boolean",
      "description": "Whether to stream back partial progress."
    },
    "stop": {
      "type": "string",
      "description": "Up to 4 sequences where the API will stop generating further tokens."
    },
    "presence_penalty": {
      "type": "number",
      "description": "Penalizes new tokens based on whether they appear in the text so far."
    },
    "frequency_penalty": {
      "type": "number",
      "description": "Penalizes new tokens based on their existing frequency in the text."
    },
    "user": {
      "type": "string",
      "description": "A unique identifier representing your end-user."
    }
  }
}