Models - List

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-10-21

Azure OpenAI リソースからアクセスできるすべてのモデルの一覧を取得します。これには、基本モデルと、Azure OpenAI リソースが所有するすべての正常に完了した微調整済みモデルが含まれます。

GET {endpoint}/openai/models?api-version=2024-10-21

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

名前	必須	型	説明
api-key	True	string	コグニティブサービスの Azure OpenAI アカウントキーをここで指定します。

応答

名前	型	説明
200 OK	ModelList	成功
Other Status Codes	ErrorResponse	エラーが発生しました。

セキュリティ

api-key

コグニティブサービスの Azure OpenAI アカウントキーをここで指定します。

型: apiKey
/: header

例

Getting all models owned by account.

要求のサンプル

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2024-10-21

応答のサンプル

状態コード:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

定義

名前	説明
Capabilities	資格
Deprecation	廃止
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	モデル
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

資格

名前	型	説明
chat_completion	boolean	モデルがチャット完了をサポートしているかどうかを示す値。
completion	boolean	モデルが完了をサポートしているかどうかを示す値。
embeddings	boolean	モデルが埋め込みをサポートしているかどうかを示す値。
fine_tune	boolean	モデルを微調整に使用できるかどうかを示す値。
inference	boolean	モデルをデプロイできるかどうかを示す値。

Deprecation

廃止

名前	型	説明
fine_tune	integer	このモデルの微調整サポートの終了日。モデルを微調整するために `null` されます。
inference	integer	このモデルの推論サポートの終了日。

Error

エラー

名前	型	説明
code	ErrorCode	ErrorCode Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されているエラーコード。
details	Error[]	エラーの詳細 (使用可能な場合)。
innererror	InnerError	InnerError Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されている内部エラー。
message	string	このエラーのメッセージ。
target	string	エラーが発生した場所 (使用可能な場合)。

ErrorCode

名前	型	説明
conflict	string	要求された操作が現在のリソースの状態と競合しています。
contentFilter	string	安全システムの結果、画像の生成に失敗しました。
fileImportFailed	string	ファイルのインポートに失敗しました。
forbidden	string	この操作は、現在のユーザー/API キーでは禁止されています。
internalFailure	string	内部エラー。再試行してください。
invalidPayload	string	要求データがこの操作に対して無効です。
itemDoesAlreadyExist	string	項目は既に存在します。
jsonlValidationFailed	string	jsonl データの検証に失敗しました。
notFound	string	リソースが見つかりません。
quotaExceeded	string	クォータを超えました。
serviceUnavailable	string	このサービスは現在使用できません。
tooManyRequests	string	要求が多すぎます。後で再試行してください。
unauthorized	string	現在のユーザー/API キーは、操作に対して承認されていません。
unexpectedEntityState	string	この操作は、現在のリソースの状態では実行できません。

ErrorResponse

名前	型	説明
error	Error	エラー Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されているエラーコンテンツ。

FineTuningState

名前	型	説明
cancelled	string	操作が取り消され、不完全です。これは、終了状態として分類できます。
created	string	操作が作成されました。この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。非アクティブな状態として分類できます。
failed	string	操作はエラーで処理を完了しており、それ以上使用することはできません。これは、終了状態として分類できます。
pending	string	この操作は、今後処理されるキューにまだありません。非アクティブな状態として分類できます。
running	string	操作の処理が開始されました。アクティブな状態として分類できます。
succeeded	string	操作が正常に処理され、使用する準備が整いました。これは、終了状態として分類できます。

InnerError

名前	型	説明
code	InnerErrorCode	InnerErrorCode Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されている内部エラーコード。
innererror	InnerError	InnerError Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されている内部エラー。

InnerErrorCode

名前	型	説明
invalidPayload	string	要求データがこの操作に対して無効です。

LifeCycleStatus

名前	型	説明
generally-available	string	モデルは一般提供されています。
preview	string	モデルはプレビュー段階であり、サービスプレビューの用語でカバーされています。

Model

モデル

名前	型	説明
capabilities	Capabilities	資格基本モデルまたは微調整モデルの機能。
created_at	integer	このジョブまたは項目が作成されたときのタイムスタンプ (unix エポック)。
deprecation	Deprecation	廃止モデルのさまざまなユースケースの非推奨の日付を定義します。通常、基本モデルでは、作成後 1 年間の微調整がサポートされます。推論は、通常、基本モデルまたは微調整されたモデルの作成から 2 年後にサポートされます。正確な日付はプロパティで指定されます。
fine_tune	string	微調整モデルの場合の微調整ジョブ ID (微調整 ID)。それ以外の場合は `null`。
id	string	この項目の ID。
lifecycle_status	LifeCycleStatus	LifeCycleStatus モデルのライフサイクルの状態。注: モデルは "プレビュー" から "一般公開" に昇格できますが、"一般公開" から "プレビュー" に昇格することはできません。
model	string	これが微調整モデルの場合の基本モデル ID (model-id)。それ以外の場合は `null`。
object	TypeDiscriminator	TypeDiscriminator オブジェクトの型を定義します。
status	FineTuningState	FineTuningState 微調整オブジェクトまたは微調整ジョブの状態。

ModelList

名前	型	説明
data	Model[]	項目の一覧。
object	TypeDiscriminator	TypeDiscriminator オブジェクトの型を定義します。

TypeDiscriminator

名前	型	説明
batch	string	このオブジェクトはバッチを表します。
file	string	このオブジェクトはファイルを表します。
fine_tuning.job	string	このオブジェクトは、微調整ジョブを表します。
fine_tuning.job.checkpoint	string	このオブジェクトは、微調整ジョブのチェックポイントを表します。
fine_tuning.job.event	string	このオブジェクトは、微調整ジョブのイベントを表します。
list	string	このオブジェクトは、他のオブジェクトの一覧を表します。
model	string	このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。
upload	string	このオブジェクトは、ファイルのアップロードを表します。
upload.part	string	このオブジェクトは、ファイルのアップロードの一部を表します。

次の方法で共有

Models - List

URI パラメーター

要求ヘッダー

応答

セキュリティ

api-key

例

Getting all models owned by account.

要求のサンプル

応答のサンプル

定義

Capabilities

Deprecation

Error

ErrorCode

ErrorResponse

FineTuningState

InnerError

InnerErrorCode

LifeCycleStatus

Model

ModelList

TypeDiscriminator

その他のリソース