Azure OpenAI в Microsoft Foundry Models REST API reference (classic)

В настоящее время просмотр:Версия портала Foundry (классическая версия - )Переход на версию для нового портала Foundry

В этой статье приведена информация о конечных точках вывода REST API для Azure OpenAI.

API specs

Управление и взаимодействие с моделями и ресурсами Azure OpenAI разделены на три основных поверхности API:

• Control plane
• Плоскость данных — авторинг
• Плоскость данных — вывод

Каждая поверхность/спецификация API инкапсулирует разный набор возможностей Azure OpenAI. Каждый API имеет свой уникальный набор версий предварительного просмотра и стабильных/общедоступных (GA) версий API. В настоящее время превью обычно выходят по ежемесячному ритму.

Authentication

Azure OpenAI предлагает два метода аутентификации. Вы можете использовать либо API Keys, либо Microsoft Entra ID.

• Аутентификация ключа API: для такого типа аутентификации все запросы API должны содержать ключ API в api-key заголовке HTTP. Quickstart предоставляет рекомендации по совершению звонков с помощью такого типа аутентификации.

• Microsoft Entra ID аутентификация: Вы можете аутентифицировать вызов API с помощью токена Microsoft Entra. Токены аутентификации включены в запрос в качестве Authorization заголовка. Предоставленный токен должен быть предшествован Bearer, например Bearer YOUR_AUTH_TOKEN, . Вы можете прочитать наше руководство по аутентификации с помощью Microsoft Entra ID.

Версионирование REST API

API сервисов версируются с использованием api-version параметра запроса. Все версии следуют структуре ГГГГMM-DD даты. For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Вывод по плоскости данных

Остальная часть статьи посвящена выпуску GA-спецификации OpenAI для выведения плоскости данных Azure, 2024-10-21.

Если вы ищете документацию по последнему выпуску предварительного просмотра API, обратитесь к последнему API preview data plane inference

Completions

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

Создаёт завершение для предоставленного запроса, параметров и выбранной модели.

URI Parameters

Request Header

Request Body

Content-Type: application/json

Responses

Код статуса: 200

Description: OK

Код статуса: по умолчанию

Описание: Услуга недоступна

Examples

Example

Создаёт завершение для предоставленного запроса, параметров и выбранной модели.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Ответы: Код статуса: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Embeddings

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Получите векторное представление заданного входа, которое легко воспринимается моделями и алгоритмами машинного обучения.

URI Parameters

Request Header

Request Body

Content-Type: application/json

Responses

Свойства для использования

prompt_tokens

total_tokens

Код статуса: 200

Description: OK

Examples

Example

Верните вложения для заданного запроса.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

Ответы: Код статуса: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chat completions

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Создаёт завершение сообщения в чате

URI Parameters

Request Header

Request Body

Content-Type: application/json

Responses

Код статуса: 200

Description: OK

Код статуса: по умолчанию

Описание: Услуга недоступна

Examples

Example

Создаёт завершение для предоставленного запроса, параметров и выбранной модели.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Ответы: Код статуса: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Создаёт завершение на основе данных Azure Search и управляемой идентичности, назначенной системой.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Ответы: Код статуса: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Создаёт завершение на основе данных вектора поиска Azure, предыдущего сообщения ассистента и управляемой личности, назначенной пользователем.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Ответы: Код статуса: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Создаёт завершение для предоставленной Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Ответы: Код статуса: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Транскрипции — Создайте

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Транскрибирует аудио на язык входа.

URI Parameters

Request Header

Request Body

Content-Type: multipart/form-data

Responses

Код статуса: 200

Description: OK

Examples

Example

Получает транскрибированный текст и связанные метаданные из предоставленных аудиоданных.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Ответы: Код статуса: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Получает транскрибированный текст и связанные метаданные из предоставленных аудиоданных.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Ответы: Код статуса: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Переводы - Create

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Транскрибирует и переводит входные аудиозаписи на английский текст.

URI Parameters

Request Header

Request Body

Content-Type: multipart/form-data

Responses

Код статуса: 200

Description: OK

Examples

Example

Получает транскрибированный текст на английском языке и связанные с ним метаданные из предоставленных аудиоданных.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Ответы: Код статуса: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Получает транскрибированный текст на английском языке и связанные с ним метаданные из предоставленных аудиоданных.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Ответы: Код статуса: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Image generation

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Генерирует набор изображений из текстовой подписи при заданном развертывании модели dall-e

URI Parameters

Request Header

Request Body

Content-Type: application/json

Responses

Код статуса: 200

Description: Ok

Код статуса: по умолчанию

Описание: произошла ошибка.

Examples

Example

Создаёт изображения по заданию.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Ответы: Код статуса: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Components

errorResponse

errorBase

error

innerError

Внутренняя ошибка с дополнительными деталями.

innerErrorCode

Коды ошибок для внутреннего объекта ошибки.

Описание: коды ошибок для объекта внутренних ошибок.

Type: string

Default:

Имя enum: InnerErrorCode

Enum Values:

dalleErrorResponse

dalleError

dalleInnerError

Внутренняя ошибка с дополнительными деталями.

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

Свойства цитирования

URL

license

contentFilterResultsBase

Информация о результатах фильтрации контента.

contentFilterPromptResults

Информация о категории фильтрации контента (ненависть, сексуальное, насилие self_harm), выявлена ли она, а также уровень тяжести (very_low, низкий, средний, высокий масштаб, определяющий интенсивность и уровень риска вредного контента) и была ли она отфильтрована. Информация о джейлбрейк-контенте и нецензурной лексике, были ли они обнаружены и были ли отфильтрованы или нет. И информация о списке блокировки клиентов, если он был отфильтрован, и его идентификаторе.

contentFilterChoiceResults

Информация о категории фильтрации контента (ненависть, сексуальное, насилие self_harm), выявлена ли она, а также уровень тяжести (very_low, низкий, средний, высокий масштаб, определяющий интенсивность и уровень риска вредного контента) и была ли она отфильтрована. Информация о стороннем тексте и нецензурной лексике, обнаружена ли она и была ли отфильтрована или нет. И информация о списке блокировки клиентов, если он был отфильтрован, и его идентификаторе.

promptFilterResult

Фильтрация контента по одному запросу в запросе.

promptFilterResults

Фильтрация контента приводит к нулю или более запросов в запросе. При стриминговом запросе результаты по разным запросам могут приходить в разное время или в разном порядке.

Для этого компонента не определённых свойств.

dalleContentFilterResults

Информация о результатах фильтрации контента.

dalleFilterResults

Информация о категории фильтрации контента (ненависть, сексуальное, насилие self_harm), выявлена ли она, а также уровень тяжести (very_low, низкий, средний, высокий масштаб, определяющий интенсивность и уровень риска вредного контента) и была ли она отфильтрована. Информация о джейлбрейк-контенте и нецензурной лексике, были ли они обнаружены и были ли отфильтрованы или нет. И информация о списке блокировки клиентов, если он был отфильтрован, и его идентификаторе.

chatCompletionsRequestCommon

createCompletionRequest

createCompletionResponse

Представляет ответ на завершение от API. Примечание: потоковые и непотоковые объекты ответов имеют одну и ту же форму (в отличие от чат-эндпоинта).

createChatCompletionRequest

chatCompletionFunctions

chatCompletionFunctionCallOption

Определение определённой функции через {"name": "my_function"} заставляет модель вызывать эту функцию.

chatCompletionRequestMessage

Этот компонент может быть одним из следующих:

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

Свойства для function_call

arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

chatCompletionRequestSystemMessageContentPart

Этот компонент может быть одним из следующих:

chatCompletionRequestUserMessageContentPart

Этот компонент может быть одним из следующих:

chatCompletionRequestAssistantMessageContentPart

Этот компонент может быть одним из следующих:

chatCompletionRequestToolMessageContentPart

Этот компонент может быть одним из следующих:

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

Свойства для image_url

url

detail

chatCompletionRequestMessageContentPartRefusal

azureChatExtensionConfiguration

Представление конфигурационных данных для одного расширения чата Azure OpenAI. Это будет использоваться для запроса на завершение чата, который должен использовать расширения чата Azure OpenAI для усиления поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

azureChatExtensionType

Представление конфигурационных данных для одного расширения чата Azure OpenAI. Это будет использоваться для запроса на завершение чата, который должен использовать расширения чата Azure OpenAI для усиления поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

Описание: Представление конфигурационных данных для одного расширения чата Azure OpenAI. Это будет использоваться для запроса на завершение чата, который должен использовать расширения чата Azure OpenAI для усиления поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

Type: string

Default:

Enum Name: AzureChatExtensionType

Enum Values:

azureSearchChatExtensionConfiguration

Конкретное представление настраиваемых опций для Azure Search при использовании его в качестве расширения чата Azure OpenAI.

azureSearchChatExtensionParameters

Параметры для Azure Search при использовании в качестве расширения чата Azure OpenAI.

azureSearchIndexFieldMappingOptions

Опциональные настройки для управления обработкой полей при использовании настроенного ресурса поиска Azure.

azureSearchQueryType

Тип поискового запроса в Azure Search, который должен выполняться при использовании его в качестве расширения чата Azure OpenAI.

Description: тип поискового запроса Azure Search, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.

Type: string

Default:

Enum Name: AzureSearchQueryType

Enum Values:

azureCosmosDBChatExtensionConfiguration

Специфическое представление конфигурируемых опций для Azure Cosmos DB при использовании её в качестве расширения чата Azure OpenAI.

azureCosmosDBChatExtensionParameters

Параметры для использования при конфигурировании Azure OpenAI на расширениях чата Your Data при использовании Azure Cosmos DB for MongoDB vCore.

azureCosmosDBFieldMappingOptions

Опциональные настройки для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.

onYourDataAuthenticationOptions

Опции аутентификации для Azure OpenAI на ваших данных.

onYourDataAuthenticationType

Типы аутентификации, поддерживаемые Azure OpenAI на ваших данных.

Описание: Типы аутентификации, поддерживаемые Azure OpenAI On Your Data.

Type: string

Default:

Имя enum: OnYourDataAuthenticationType

Enum Values:

onYourDataApiKeyAuthenticationOptions

Опции аутентификации для Azure OpenAI на ваших данных при использовании ключа API.

onYourDataConnectionStringAuthenticationOptions

Опции аутентификации для Azure OpenAI On Your Data при использовании строка подключения.

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Опции аутентификации для Azure OpenAI на ваших данных при использовании управляемой идентичности, назначенной системой.

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Опции аутентификации для Azure OpenAI на ваших данных при использовании управляемой личности, назначенной пользователем.

onYourDataVectorizationSource

Абстрактное представление источника векторизации для Azure OpenAI On Your Data с векторным поиском.

onYourDataVectorizationSourceType

Представляет доступные источники, которые Azure OpenAI On Your Data может использовать для настройки векторизации данных для использования с векторным поиском.

Description: Представляет доступные источники, Azure OpenAI On Your Data может использовать для настройки векторизации данных для использования с
vector search.

Type: string

Default:

Имя enum: OnYourDataVectorizationSourceType

Enum Values:

onYourDataDeploymentNameVectorizationSource

Детали источника векторизации, используемого Azure OpenAI On Your Data при применении векторного поиска, основанного на внутреннем имени модели развертывания в том же ресурсе Azure OpenAI.

onYourDataEndpointVectorizationSource

Детали источника векторизации, используемого Azure OpenAI On Your Data при применении векторного поиска, основанного на публичном запросе Azure OpenAI для вложения.

azureChatExtensionsMessageContext

Представление дополнительной контекстной информации, доступной при формировании ответа на завершение чата Azure OpenAI. Эта контекстная информация заполняется только при использовании запроса Azure OpenAI, настроенного на соответствующее расширение.

citation

Информация о цитировании для ответа на завершение чата.

chatCompletionMessageToolCall

Свойства функции

name

arguments

toolCallType

Тип вызова инструмента, в данном случае function.

Описание: тип вызова инструмента, в данном случае function.

Type: string

Default:

Имя enum: ToolCallType

Enum Values:

chatCompletionRequestMessageTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

Представляет ответ на завершение чата, возвращаемый моделью на основе предоставленного входа.

createChatCompletionStreamResponse

Представляет собой потоковый фрагмент ответа на завершение чата, возвращаемый моделью на основе предоставленного входа.

chatCompletionStreamResponseDelta

Дельта завершения чата, генерируемая потоковыми ответами моделей.

Свойства для function_call

arguments

name

chatCompletionMessageToolCallChunk

Свойства функции

name

arguments

chatCompletionStreamOptions

Варианты для потокового отклика. Устанавливайте это только тогда, когда устанавливаете stream: true.

chatCompletionChoiceLogProbs

Записывайте вероятностную информацию для выбора.

chatCompletionTokenLogprob

chatCompletionResponseMessage

Сообщение о завершении чата, генерируемое моделью.

chatCompletionResponseMessageRole

Роль автора ответного сообщения.

Описание: Роль автора ответного сообщения.

Type: string

Default:

Enum Values:

• assistant

chatCompletionToolChoiceOption

Управляет, который (если вообще есть) называется моделью. none это означает, что модель не вызывает никакой инструмент, а вместо этого генерирует сообщение. auto означает, что модель может выбирать между генерацией сообщения и вызовом одного или нескольких инструментов. required значит, модель должна вызывать один или несколько инструментов. Указание конкретного инструмента через {"type": "function", "function": {"name": "my_function"}} заставляет модель вызывать этот инструмент. none является по умолчанию, когда инструменты отсутствуют. auto является по умолчанию, если инструменты присутствуют.

Этот компонент может быть одним из следующих:

chatCompletionNamedToolChoice

Указывает инструмент, который должна использовать модель. Используй, чтобы заставить модель вызывать конкретную функцию.

Свойства функции

name

ParallelToolCalls

Можно ли включать параллельный вызов функций во время использования инструмента.

Для этого компонента не определённых свойств.

chatCompletionMessageToolCalls

Вызовы инструментов, генерируемые моделью, такие как вызовы функций.

Для этого компонента не определённых свойств.

chatCompletionFunctionCall

Устаревший и заменённый на tool_calls. Имя и аргументы функции, которую следует вызвать, как они генерируются моделью.

completionUsage

Статистика использования для запроса на завершение.

Свойства для completion_tokens_details

reasoning_tokens

chatCompletionTool

FunctionParameters

Параметры, которые принимают функции, описываются как объект схемы JSON. Смотрите руководство для примеров и справочник JSON Schema для документации по формату.

Опущение parameters определяет функцию с пустым списком параметров.

Для этого компонента не определённых свойств.

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

Схема формата ответа, описываемая как объект схемы JSON.

Для этого компонента не определённых свойств.

ResponseFormatJsonSchema

Свойства для json_schema

description

name

schema

strict

chatCompletionChoiceCommon

createTranslationRequest

Translation request.

audioResponse

Ответ перевода или транскрипции, когда response_format был json

audioVerboseResponse

Ответ на перевод или транскрипцию, когда response_format был verbose_json

audioResponseFormat

Определяет формат выхода.

Описание: Определяет формат выхода.

Type: string

Default:

Enum Values:

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

Transcription request.

audioSegment

Сегмент транскрипции или перевода.

imageQuality

Качество изображения, которое будет создано.

Описание: Качество изображения, которое будет создано.

Type: string

Default: standard

Имя Enum: Качество

Enum Values:

imagesResponseFormat

Формат, в котором возвращаются сгенерированные изображения.

Описание: формат, в котором возвращаются сгенерированные изображения.

Type: string

Default: url

Имя enum: ImagesResponseFormat

Enum Values:

imageSize

Размер сгенерированных изображений.

Описание: размер сгенерированных изображений.

Type: string

Default: 1024x1024

Имя энума: размер

Enum Values:

imageStyle

Стиль сгенерированных изображений.

Описание: Стиль сгенерированных изображений.

Type: string

Default: vivid

Имя Энума: Стиль

Enum Values:

imageGenerationsRequest

generateImagesResponse

imageResult

URL изображения или закодированное изображение, если успешно, а в противном случае — ошибка.

Completions extensions

Расширения завершений не входят в последнюю GA версию спецификации Azure OpenAI data plane inference.

Chatmessage

Объект сообщения Chat не входит в последнюю GA версию спецификации выведения плоскости данных Azure OpenAI.

Текст в речь (Предварительный просмотр)

В настоящее время не входит в последнюю версию Azure OpenAI GA спецификаци Azure и OpenAI Data Plane inference. Для этой возможности обратитесь к последней версии preview.

Next steps

Узнайте о моделях и тонкой настройке с помощью REST API. Узнайте больше о недоумение моделей, которые Azure OpenAI.