Справочник по REST API версии 1 для моделей Azure OpenAI в Azure AI Foundry.

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

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

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

Если вы ищете документацию по последнему выпуску API общедоступной версии, обратитесь к последнему API вывода плоскости данных общедоступной версии

Создание речи

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Генерирует аудио для преобразования текста в речь.

Параметры URI

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

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

Тело запроса

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

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

POST {endpoint}/openai/v1/audio/speech?api-version=preview

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

Ответы: код состояния: 200

{
  "body": "101010101"
}

Создание транскрибирования

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

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

Параметры URI

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

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

Тело запроса

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "verbose_json"
}

Ответы: код состояния: 200

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

Пример

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Ответы: код состояния: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Создание завершения чата

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Создает завершение чата.

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "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?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Создание завершения

POST {endpoint}/openai/v1/completions?api-version=preview

Создает завершение.

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

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

POST {endpoint}/openai/v1/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "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
    }
  }
}

Создание внедрения

POST {endpoint}/openai/v1/embeddings?api-version=preview

Создает вектор внедрения, представляющий входной текст.

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

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

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "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,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

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

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

Изменяет изображение из текстового заголовка для заданного развертывания модели gpt-image-1

Параметры URI

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

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

Тело запроса

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

Ответы

Код состояния: 200

Описание: ОК

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

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

Создание образа

POST {endpoint}/openai/v1/images/generations?api-version=preview

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

Создает изображения с запросом.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "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 {endpoint}/openai/v1/responses?api-version=preview

Создает модельный ответ.

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

Создать примерный ответ

POST {endpoint}/openai/v1/responses?api-version=preview

Получение ответа

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Извлекает ответ модели с заданным идентификатором.

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Удаление ответа

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Удаляет ответ по идентификатору.

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Listinputitems

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

Возвращает список входных элементов для заданного ответа.

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Задания создания видео — создание

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Параметры URI

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

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

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Примеры

Пример

Создание задания создания видео

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

{
 "prompt": "A cat playing piano in a jazz bar.",
 "model": "video-gen-001"
}

Ответы: код состояния: 200

{
  "body": {
    "id": "vidjob_1234567890",
    "object": "video_generation_job",
    "created": 1680000000,
    "status": "queued",
    "prompt": "A cat playing piano in a jazz bar.",
    "model": "video-gen-001"
  }
}

Задания создания видео — список

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Задания создания видео — Получение

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Задания создания видео — удаление

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 204

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

Описание: непредвиденная ошибка.

Поколения видео — Получить

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Генерация видео — получение миниатюры

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Поколения видео — восстановление видео

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Параметры URI

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

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

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

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

Описание: непредвиденная ошибка.

Компоненты

AudioTaskLabel

Определяет возможные дескрипторы для доступных ответов на звуковые операции.

AzureAIFoundryModelsApiVersion

AzureAudioTranscriptionResponse

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

AzureChatCompletionResponseMessage

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

AzureChatCompletionStreamResponseDelta

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

AzureChatDataSource

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

Дискриминатор для AzureChatDataSource

Этот компонент использует свойство type для дискриминации между различными типами:

Опции аутентификации с токеном доступа источника данных AzureChat

Параметры аутентификации ключа API источника данных AzureChat

AzureChatDataSourceAuthenticationOptions

Дискриминатор для AzureChatDataSourceAuthenticationOptions

Этот компонент использует свойство type для дискриминации между различными типами:

AzureChatИсточникДанныхПараметрыАутентификацииТип

AzureChatDataSourceConnectionStringAuthenticationOptions

AzureChatИсточникДанныхРазвёртываниеИмяВекторизацияИсточник

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

Параметры аутентификации с использованием закодированного API-ключа для AzureChatDataSource

AzureChatDataSourceEndpointVectorizationSource

Представляет собой источник векторизации, осуществляющий публичные вызовы службы к развертыванию модели встраивания Azure OpenAI.

AzureChatИсточникДанныхИнтегрированныйВекторизацияSource

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

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

ИсточникВекторизацииМоделиИДанныхАзурЧат

Представляет источник векторизации данных, который осуществляет вызовы сервисов на основе идентификатора модели службы поиска. Этот исходный тип в настоящее время поддерживается только Elasticsearch.

Параметры аутентификации управляемой идентичности, назначенной системой AzureChatDataSource

AzureЧатТипИсточникаДанных

Параметры аутентификации управлямой идентичности, назначенные пользователю для AzureChatDataSource

Параметры аутентификации с использованием имени пользователя и пароля для AzureChatDataSource (AzureChatDataSourceUsernameAndPasswordAuthenticationOptions)

АжурЧатДанныеИсточникВекторизации

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

Дискриминатор для AzureChatDataSourceVectorizationSource

Этот компонент использует свойство type для дискриминации между различными типами:

AzureChatDataSourceТипИсточникВекторизации

AzureChatMessageContext

Дополнительное свойство, добавленное в сообщения ответа на завершение чата, созданное службой Azure OpenAI при использовании поведения расширения. Сюда входят сведения о намерении и ссылке из функции On Your Data.

Результат запретного списка фильтрации контента Azure

Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.

AzureContentFilterCompletionTextSpan

Представление текста завершённого сегмента, используемого результатами фильтрации содержимого Azure OpenAI.

Результат обнаружения текстовых диапазонов завершения фильтра контента Azure

Результат обнаружения фильтра содержимого Azure

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

Результаты запроса фильтрации контента Azure для изображений (AzureContentFilterImagePromptResults)

Результат фильтра содержимого для содержимого входного запроса операции создания изображения.

AzureContentFilterImageResponseResults

Результат фильтрации содержимого для вывода содержимого ответа операции генерации изображений.

РезультатФильтрацииКонтентаAzureДляВыбора

Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта.

Результат фильтра контента Azure для запроса

Результат фильтрации содержимого, связанный с одним элементом входного запроса в генеративную систему ИИ.

AzureContentFilterSeverityResult

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

AzureCosmosDBChatDataSource

Представляет конфигурацию источника данных, которая будет использовать ресурс Azure CosmosDB.

AzureСоздатьЗапросНаЗавершениеЧата

Модель расширенного запроса для завершения чата в службе Azure OpenAI. Это добавляет возможность предоставлять источники данных для функции On Your Data.

AzureCreateChatCompletionResponse

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

Ответ на запрос AzureCreateChatCompletionStream

AzureCreateCompletionRequest (запрос завершения создания в Azure)

АзурСоздатьОтветНаЗавершение

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

AzureCreateEmbeddingRequest

AzureCreateImageEditRequestMultiPart

Запрос на создание изображения Azure

AzureCreateResponse

АзурКриейтСпичРеквестМультиПарт

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

Запрос на создание транскрипции AzureMultiPart

Сведения о конфигурации запроса транскрибирования звука.

Ответ об ошибке Azure

AzureImage

AzureImagesResponse

Ответ об ошибке генерации видео AzureOpenAI

AzureResponse

AzureSearchChatDataSource

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

AzureUserSecurityContext (Контекст безопасности пользователя Azure)

Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Узнайте больше о защите приложений ИИ с помощью Microsoft Defender для облака.

AzureVideoGenerationError

Тип: объект

Элемент вызовов инструментов сообщения завершения чата

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

Массив: OpenAI.ChatCompletionMessageToolCall

ЗавершениеChoice

СоздатьЗапросНаГенерациюВидео

ElasticsearchChatDataSource

Статус работы

MongoDBChatDataSource