Models - List
Azure OpenAI リソースからアクセスできるすべてのモデルの一覧を取得します。 これには、基本モデルと、Azure OpenAI リソースが所有するすべての正常に完了した微調整モデルが含まれます。
GET {endpoint}/openai/models?api-version=2023-12-01-preview
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 |
Cognitive Services Azure OpenAI アカウント キーをここに入力します。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
エラーが発生しました。 |
セキュリティ
api-key
Cognitive Services Azure OpenAI アカウント キーをここに入力します。
型:
apiKey
/:
header
例
Getting all models owned by account.
要求のサンプル
GET https://aoairesource.openai.azure.com/openai/models?api-version=2023-12-01-preview
応答のサンプル
{
"data": [
{
"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",
"status": "succeeded",
"created_at": 1646126127,
"updated_at": 1646127311,
"object": "model"
},
{
"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",
"status": "succeeded",
"created_at": 1646126127,
"updated_at": 1646127311,
"object": "model"
}
],
"object": "list"
}
定義
名前 | 説明 |
---|---|
Capabilities |
機能 |
Deprecation |
非推奨 |
Error |
エラー |
Error |
ErrorCode |
Error |
ErrorResponse |
Fine |
FineTuningState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Life |
LifeCycleStatus |
Model |
モデル |
Model |
ModelList |
Type |
TypeDiscriminator |
Capabilities
機能
名前 | 型 | 説明 |
---|---|---|
chat_completion |
boolean |
モデルがチャット完了をサポートしているかどうかを示す値。 |
completion |
boolean |
モデルが完了をサポートするかどうかを示す値。 |
embeddings |
boolean |
モデルが埋め込みをサポートしているかどうかを示す 値。 |
fine_tune |
boolean |
微調整にモデルを使用できるかどうかを示す値。 |
inference |
boolean |
モデルをデプロイできるかどうかを示す値。 |
Deprecation
非推奨
名前 | 型 | 説明 |
---|---|---|
fine_tune |
integer |
このモデルのサポートを微調整する終了日。 モデルを微調整するためのものになります |
inference |
integer |
このモデルの推論サポートの終了日。 |
Error
エラー
名前 | 型 | 説明 |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
エラーの詳細 (使用可能な場合)。 |
innererror |
InnerError |
|
message |
string |
このエラーのメッセージ。 |
target |
string |
エラーが発生した場所 (使用可能な場合)。 |
ErrorCode
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
ErrorResponse
名前 | 型 | 説明 |
---|---|---|
error |
エラー |
FineTuningState
FineTuningState
名前 | 型 | 説明 |
---|---|---|
cancelled |
string |
操作が取り消され、不完全です。 これは、終了状態として分類できます。 |
created |
string |
操作が作成されました。 この状態は Azure OpenAI によって返されず、互換性のためにのみ公開されます。 非アクティブ状態として分類できます。 |
failed |
string |
操作はエラーで処理を完了しており、それ以上使用することはできません。 これは、終了状態として分類できます。 |
pending |
string |
この操作は、今後処理されるキューにまだありません。 非アクティブ状態として分類できます。 |
running |
string |
操作の処理が開始されました。 アクティブな状態として分類できます。 |
succeeded |
string |
操作が正常に処理され、使用の準備が整いました。 これは、終了状態として分類できます。 |
InnerError
InnerError
名前 | 型 | 説明 |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
名前 | 型 | 説明 |
---|---|---|
invalidPayload |
string |
この操作の要求データが無効です。 |
LifeCycleStatus
LifeCycleStatus
名前 | 型 | 説明 |
---|---|---|
generally-available |
string |
モデルは一般提供されています。 |
preview |
string |
モデルはプレビュー段階であり、サービス プレビューの用語の対象となります。 |
Model
モデル
名前 | 型 | 説明 |
---|---|---|
capabilities |
機能 |
|
created_at |
integer |
このジョブまたは項目が作成されたときのタイムスタンプ (unix エポック)。 |
deprecation |
非推奨 |
|
fine_tune |
string |
微調整モデルの場合の微調整ジョブ ID (微調整 ID)。それ以外の場合 |
id |
string |
このアイテムの ID。 |
lifecycle_status |
LifeCycleStatus |
|
model |
string |
これが微調整モデルの場合は、基本モデル ID (model-id)。それ以外の場合 |
object |
TypeDiscriminator |
|
status |
FineTuningState |
|
updated_at |
integer |
このジョブまたは項目が最後に変更されたときのタイムスタンプ (unix エポック)。 |
ModelList
ModelList
名前 | 型 | 説明 |
---|---|---|
data |
Model[] |
項目の一覧。 |
object |
TypeDiscriminator |
TypeDiscriminator
TypeDiscriminator
名前 | 型 | 説明 |
---|---|---|
file |
string |
このオブジェクトは、ファイルを表します。 |
fine-tune |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine-tune-event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
fine_tuning.job |
string |
このオブジェクトは、微調整ジョブを表します。 |
fine_tuning.job.event |
string |
このオブジェクトは、微調整ジョブのイベントを表します。 |
list |
string |
このオブジェクトは、他のオブジェクトの一覧を表します。 |
model |
string |
このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。 |