справочник Azure по REST API для изображений и звука OpenAI (2024-10-21)

В этой статье описаны операции создания изображений и плоскости звука (речь) для операций REST API вывода для Azure OpenAI в выпуске общедоступной 2024-10-21 версии. Сведения о завершении чата, внедрениях, завершениях и всех других операциях см. в официальной Azure справочнике по REST API OpenAI.

Спецификации API

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

  • Контрольная плоскость
  • Плоскость данных — авторинг
  • Плоскость данных — вывод

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

Important

Теперь появился новый API предпросмотра вывода. Узнайте больше в нашем руководстве по жизненному циклу API.

API Последний превью релиза Последний релиз GA Specifications Описание
Контрольная плоскость 2025-07-01-preview 2025-06-01 Файлы спецификаций API плоскости управления используется для операций, таких как создание ресурсов, развертывание моделей и другие задачи управления ресурсами высокого уровня. Плоскость управления также регулирует, что можно делать с такими возможностями, как Azure Resource Manager, Bicep, Terraform и Azure CLI.
Плоскость данных v1 preview v1 Файлы спецификаций 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 даты. Рассмотрим пример.

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

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

В остальной части этой статьи рассматриваются операции с изображением и звуком в выпуске общедоступной версии спецификации вывода Azure плоскости 2024-10-21данных OpenAI.

Сведения о предварительном просмотре изображений и звуковых операций см. в справочнике по предварительному просмотру образа и REST API аудио.

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

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

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

Параметры URI

Имя. In Обязательный Тип Описание
endpoint path Yes string
url		 Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор развертывания path Yes string ID развертывания модели речи в текст.

Для информации о поддерживаемых моделях см. [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version Запрос Yes string Версия API

Заголовок запроса

Имя. Обязательный Тип Описание
API-ключ True string Предоставьте ключ API Azure OpenAI здесь

Тело запроса

Content-Type: многочастный формат данных

Имя. Тип Описание Обязательный По умолчанию
file string Аудиофайл возражает для транскрибации. Yes
prompt string Необязательный текст для руководства стилем модели или продолжения предыдущего аудиосегмента. Запрос должен соответствовать языку аудио. Нет
формат_ответа audioResponseFormat Определяет формат выхода. Нет
Температура number Температура выборки — от 0 до 1. Более высокие значения, например 0.8, делают выход более случайным, а низкие, например 0.2, делают его более сфокусированным и детерминированным. Если установлено в 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых порогов. Нет 0
язык string Язык входного аудио. Предоставление языка ввода в формате ISO-639-1 повысит точность и задержку. Нет

Ответы

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

Описание: ОК

Тип содержимого Тип Description
application/json audioResponse или audioVerboseResponse
text/plain string Транскрибированный текст в выходном формате (когда response_format был текстом, vtt или srt).

Examples

Пример

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

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"
  }
}

Пример

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

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

Имя. In Обязательный Тип Описание
endpoint path Yes string
url		 Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор развертывания path Yes string Идентификатор развертывания модели транскрибирования, развернутой.

Для информации о поддерживаемых моделях см. [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version Запрос Yes string Версия API

Заголовок запроса

Имя. Обязательный Тип Описание
API-ключ True string Предоставьте ключ API Azure OpenAI здесь

Тело запроса

Content-Type: многочастный формат данных

Имя. Тип Описание Обязательный По умолчанию
file string Аудиофайл для перевода. Yes
prompt string Необязательный текст для руководства стилем модели или продолжения предыдущего аудиосегмента. Задание должно быть на английском. Нет
формат_ответа audioResponseFormat Определяет формат выхода. Нет
Температура number Температура выборки — от 0 до 1. Более высокие значения, например 0.8, делают выход более случайным, а низкие, например 0.2, делают его более сфокусированным и детерминированным. Если установлено в 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых порогов. Нет 0

Ответы

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

Описание: ОК

Тип содержимого Тип Description
application/json audioResponse или audioVerboseResponse
text/plain string Транскрибированный текст в выходном формате (когда response_format был текстом, vtt или srt).

Examples

Пример

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

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"
  }
}

Пример

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

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"
}

Генерирование изображений

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

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

Параметры URI

Имя. In Обязательный Тип Описание
endpoint path Yes string
url		 Поддерживается Azure конечных точек OpenAI (протокол и имя хоста, например: https://aoairesource.openai.azure.com. Замените «aoairesource» на имя вашего ресурса Azure OpenAI). https://{your-resource-name}.openai.azure.com
идентификатор развертывания path Yes string ID развертывания модели dall-e, которая была развернута.
api-version Запрос Yes string Версия API

Заголовок запроса

Имя. Обязательный Тип Описание
API-ключ True string Предоставьте ключ API Azure OpenAI здесь

Тело запроса

Тип содержания: application/json

Имя. Тип Описание Обязательный По умолчанию
prompt string Текстовое описание желаемого изображения(ов). Максимальная длина — 4 000 символов. Yes
н целое число Количество изображений для генерации. Нет 1
size imageSize Размер сгенерированных изображений. Нет 1024x1024
формат_ответа imagesResponseFormat Формат, в котором возвращаются сгенерированные изображения. Нет url
user string Уникальный идентификатор, представляющий вашего конечного пользователя, который помогает отслеживать и выявлять злоупотребления. Нет
качество imageQuality Качество изображения, которое будет создано. Нет стандарт
Стиль imageStyle Стиль сгенерированных изображений. Нет Яркие

Ответы

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

Описание: ОК

Тип содержимого Тип Description
application/json generateImagesResponse

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

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

Тип содержимого Тип Description
application/json dalleErrorResponse

Examples

Пример

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

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
          }
        }
      }
    ]
  }
}

Компоненты

Определения схемы, используемые чатом, завершением, внедрением и другими текстовыми операциями, см. в Azure справочнике по REST API OpenAI. Следующие схемы поддерживают операции изображения и звука на этой странице.

innerErrorCode

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

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

Тип: строка

По умолчанию:

Имя enum: InnerErrorCode

Значения перечисления:

Ценность Описание
Нарушение политики ответственного ИИ Запрос нарушал одно из правил фильтрации контента.

dalleErrorResponse

Имя. Тип Описание Обязательный По умолчанию
error ошибка Dalle Нет

ошибка Dalle

Имя. Тип Описание Обязательный По умолчанию
параметр string Нет
type string Нет
внутренняя ошибка dalleInnerError Внутренняя ошибка с дополнительными деталями. Нет

dalleInnerError

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

Имя. Тип Описание Обязательный По умолчанию
код innerErrorCode Коды ошибок для внутреннего объекта ошибки. Нет
результаты фильтрации контента dalleFilterResults Информация о категории фильтрации контента (ненависть, сексуальное, насилие self_harm), выявлена ли она, а также уровень тяжести (very_low, низкий, средний, высокий масштаб, определяющий интенсивность и уровень риска вредного контента) и была ли она отфильтрована. Информация о джейлбрейк-контенте и нецензурной лексике, были ли они обнаружены и были ли отфильтрованы или нет. И информация о списке блокировки клиентов, если он был отфильтрован, и его идентификаторе. Нет
пересмотренный_запрос string Подсказка, которая использовалась для создания изображения, если произошла какая-либо коррекция. Нет

Результат фильтрации по степени тяжести

Имя. Тип Описание Обязательный По умолчанию
Отфильтрованный boolean Yes
severity string Нет

Обнаружен результат фильтра контента

Имя. Тип Описание Обязательный По умолчанию
Отфильтрованный boolean Yes
Обнаружено boolean Нет

dalleFilterResults

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

Имя. Тип Описание Обязательный По умолчанию
Сексуальной результат тяжести фильтрации контента Нет
Насилия результат тяжести фильтрации контента Нет
Ненавижу результат тяжести фильтрации контента Нет
самоповреждение результат тяжести фильтрации контента Нет
Ненормативной лексики Результат обнаружения фильтра контента Нет
Джейлбрейк Результат обнаружения фильтра контента Нет

аудиоОтвет

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

Имя. Тип Описание Обязательный По умолчанию
text string Переведённый или расшифрованный текст. Yes

audioVerboseResponse

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

Имя. Тип Описание Обязательный По умолчанию
text string Переведённый или расшифрованный текст. Yes
Задача string Тип аудиозадачи. Нет
язык string Language. Нет
duration number Длительность. Нет
Сегментов массив Нет

формат аудиоответа

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

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

Тип: строка

По умолчанию:

Значения перечисления:

  • json
  • text
  • srt
  • verbose_json
  • vtt

imageQuality

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

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

Тип: строка

По умолчанию: стандартный

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

Значения перечисления:

Ценность Описание
стандарт Стандартное качество создаёт изображения со стандартным качеством.
высокая четкость HD-качество создает изображения с более мелкими деталями и большей согласованностью по всему изображению.

imagesResponseFormat

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

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

Тип: строка

По умолчанию: URL-адрес

Имя enum: ImagesResponseFormat

Значения перечисления:

Ценность Описание
url URL, предоставляющий временный доступ для загрузки сгенерированных изображений.
b64_json Сгенерированные изображения возвращаются в виде строк, закодированных в базе 64.

imageSize

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

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

Тип: строка

По умолчанию: 1024x1024

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

Значения перечисления:

Ценность Описание
1792x1024 Желаемый размер сгенерированного изображения составляет 1792x1024 пикселя.
1024x1792 Желаемый размер сгенерированного изображения составляет 1024x1792 пикселя.
1024x1024 Желаемый размер сгенерированного изображения составляет 1024x1024 пикселя.

imageStyle

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

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

Тип: строка

По умолчанию: яркий

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

Значения перечисления:

Ценность Описание
Яркие Vivid создаёт гиперреалистичные и драматичные изображения.
Природных Natural создаёт более естественные и менее гиперреалистичные изображения.

generateImagesResponse

Имя. Тип Описание Обязательный По умолчанию
создано целое число Временная метка Unix при создании операции. Yes
Данные массив Результаты операции, если успешны Yes

Дальнейшие действия

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

  • Last updated on