Azure справочник по REST API для образа и звука OpenAI (2025-04-01-preview)

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

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

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

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

Каждая поверхность/спецификация 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 даты. Рассмотрим пример.

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

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

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

Сведения об изображениях и аудиозаписях см. в справочнике по ОБЩЕДОСТУПНОму изображению и REST API аудио.

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

Параметры URI

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

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

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

Ответы

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

Описание: ОК

Examples

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

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

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---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=2025-04-01-preview

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

Параметры URI

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

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

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

Ответы

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

Описание: ОК

Examples

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---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=2025-04-01-preview

"---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}/audio/speech?api-version=2025-04-01-preview

Генерирует аудио из входного текста.

Параметры URI

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

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

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

Ответы

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

Описание: ОК

Examples

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

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

{
  "body": "101010101"
}

Генерации изображений — Создавать

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

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

Параметры URI

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

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

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

Ответы

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

Описание: ОК

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

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

Examples

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Поколения изображений — редактировать

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Редактирует изображение из текстовой подписи на заданной модели gpt-image-1

Параметры URI

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

Используйте либо аутентификация на основе токенов, либо API-ключ. Рекомендуется аутентификация с помощью токен-аутентификации и более безопасной.

Тело запроса

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

Ответы

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

Описание: ОК

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

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

Компоненты

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

innerErrorCode

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

dalleErrorResponse

ошибка Dalle

dalleInnerError

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

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

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

contentFilterDetailedResults

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

dalleFilterResults

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

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

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

imageQuality

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

imagesResponseFormat

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

imagesOutputFormat

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

imageSize

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

imageStyle

Стиль сгенерированных изображений. Поддерживается только для dall-e-3.

imageBackground

Позволяет установить прозрачность для фона сгенерированного изображения(ов). Этот параметр поддерживается только для моделей серии gpt-image-1.

generateImagesResponse

imageGenerationsUsage

Представляет детали использования токена для запросов на генерацию изображений. Только для моделей серии gpt-image-1.

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

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