Azure の OpenAI モデル

API バージョン: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

サーバー変数:

Variable デフォルト Description
エンドポイント プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。

Authentication

ApiKeyAuth (API Key)

APIキーを api-key ヘッダーに渡してください。

ApiKeyAuth_(APIキー)

APIキーを authorization ヘッダーに渡してください。

OAuth2Auth (OAuth 2.0)

Flow: 暗黙的

承認 URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ：

  • https://cognitiveservices.azure.com/.default

セキュリティ要件

エンドポイントは 以下のいずれかの 認証方法を受け入れます:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (スコープ: https://cognitiveservices.azure.com/.default)

モデルを一覧表示する

GET {endpoint}/openai/v1/models

現在使用可能なモデルを一覧表示し、所有者や可用性などの各モデルに関する基本情報を提供します。

URI パラメーター

氏名 In 必須 タイプ Description
エンドポイント サーバー イエス 文字列 プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。
api-version クエリ No 文字列
使用可能な値: v1、 preview		 この要求に使用する明示的な Azure AI Foundry Models API バージョン。
v1 特に指定がない場合は。

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類） Type Description
application/json OpenAI.ListModelsResponse

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類） Type Description
application/json オブジェクト
氏名 タイプ Description 必須 デフォルト
コード string または null イエス
inner_error No
メッセージ 文字列 イエス
param string または null No
型 文字列 No

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

モデルの取得

GET {endpoint}/openai/v1/models/{model}

モデル インスタンスを取得し、所有者やアクセス許可などのモデルに関する基本情報を提供します。

URI パラメーター

氏名 In 必須 タイプ Description
エンドポイント サーバー イエス 文字列 プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。
api-version クエリ No 文字列
使用可能な値: v1、 preview		 この要求に使用する明示的な Azure AI Foundry Models API バージョン。
v1 特に指定がない場合は。
モデル パス イエス 文字列 この要求に使用するモデルの ID。

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類） Type Description
application/json OpenAI.Model

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類） Type Description
application/json オブジェクト
氏名 タイプ Description 必須 デフォルト
コード string または null イエス
inner_error No
メッセージ 文字列 イエス
param string または null No
型 文字列 No

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

モデルを削除する

DELETE {endpoint}/openai/v1/models/{model}

モデル インスタンスを削除します。

URI パラメーター

氏名 In 必須 タイプ Description
エンドポイント サーバー イエス 文字列 プロトコルとホスト名を含むサポートされたAzure AI FoundryモデルAPIエンドポイント。
例えば次が挙げられます。
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)。
api-version クエリ No 文字列
使用可能な値: v1、 preview		 この要求に使用する明示的な Azure AI Foundry Models API バージョン。
v1 特に指定がない場合は。
モデル パス イエス 文字列 削除するモデルの ID。

Responses

状態コード: 200

説明: 要求は成功しました。

Content-Type（コンテンツの種類） Type Description
application/json OpenAI.DeleteModelResponse

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

状態コード: 既定

説明: 予期しないエラー応答。

Content-Type（コンテンツの種類） Type Description
application/json オブジェクト
氏名 タイプ Description 必須 デフォルト
コード string または null イエス
inner_error No
メッセージ 文字列 イエス
param string または null No
型 文字列 No

応答ヘッダー:

ヘッダー タイプ Description
apim-request-id 文字列 トラブルシューティングの目的で使用される要求 ID。

Components

AzureAIFoundryModelsApiVersion

財産 価値
Type 文字列
値 v1
preview

OpenAI.DeleteModelResponse

氏名 タイプ Description 必須 デフォルト
削除されました boolean イエス
id 文字列 イエス
オブジェクト 文字列 イエス

OpenAI.ListModelsResponse

氏名 タイプ Description 必須 デフォルト
データ OpenAI.Model の配列 イエス
オブジェクト 列挙型
使用可能な値: list		 イエス

OpenAI.Model

Model

API で使用できる OpenAI モデル オファリングについて説明します。

氏名 タイプ Description 必須 デフォルト
created 整数(UnixTime) モデルが作成されたときの Unix タイムスタンプ (秒単位)。 イエス
id 文字列 API エンドポイントで参照できるモデル識別子。 イエス
オブジェクト 列挙型 オブジェクトの種類。これは常に "model" です。
使用可能な値: model		 イエス
owned_by 文字列 モデルを所有する組織。 イエス
  • Last updated on