Batch - List

リファレンス

サービス:: Azure AI Services

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

Azure OpenAI リソースが所有するすべてのバッチの一覧を取得します。

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

省略可能なパラメーターを含む:

GET {endpoint}/openai/batches?after={after}&limit={limit}&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 バージョン。
after	query		string	前の改ページ位置の要求からの最後のイベントの識別子。
limit	query		integer (int32)	取得するバッチの数。既定値は 20 です。

要求ヘッダー

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

応答

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

セキュリティ

api-key

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

型: apiKey
/: header

例

Getting all batches owned by this account.

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "has_more": false,
  "data": [
    {
      "object": "batch",
      "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
      "endpoint": "/chat/completions",
      "errors": null,
      "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
      "completion_window": "24h",
      "status": "completed",
      "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
      "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
      "created_at": 1646126127,
      "in_progress_at": 1646126130,
      "expires_at": 1646126170,
      "finalizing_at": 1646126134,
      "completed_at": 1646126136,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
        "total": 500,
        "completed": 400,
        "failed": 100
      },
      "first_id": "batch_abc123",
      "last_id": "batch_abc456",
      "metadata": {
        "batch_description": "Evaluation job"
      }
    }
  ],
  "object": "list"
}

定義

名前	説明
Batch	バッチ
BatchErrorData	BatchErrorData
BatchErrors	BatchErrors
BatchesList	BatchList
BatchRequestCounts	BatchRequestCounts
BatchStatus	BatchStatus
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Batch

Object

バッチ

名前	型	説明
cancelled_at	integer (unixtime)	このバッチが取り消されたときのタイムスタンプ (unix エポック)。
cancelling_at	integer (unixtime)	このバッチが取り消しを開始したときのタイムスタンプ (unix エポック)。
completed_at	integer (unixtime)	このバッチが完了したときのタイムスタンプ (unix エポック)。
completion_window	string	バッチを処理する期間。
created_at	integer (unixtime)	このバッチが作成されたときのタイムスタンプ (unix エポック)。
endpoint	string	バッチによって使用される API エンドポイント。
error_file_id	string	エラーのある要求の出力を含むファイルの ID。
errors	BatchErrors	BatchErrors 失敗したバッチの場合、エラーの原因に関する詳細情報が含まれます。
expired_at	integer (unixtime)	このバッチの有効期限が切れたときのタイムスタンプ (unix エポック)。
expires_at	integer (unixtime)	このバッチの有効期限が切れるタイムスタンプ (unix エポック)。
failed_at	integer (unixtime)	このバッチが失敗したときのタイムスタンプ (unix エポック)。
finalizing_at	integer (unixtime)	このバッチの最終処理が開始されたときのタイムスタンプ (unix エポック)。
id	string	この項目の ID。
in_progress_at	integer (unixtime)	このバッチの進行が開始されたときのタイムスタンプ (unix エポック)。
input_file_id	string minLength: 1	バッチの入力ファイルの ID。
metadata	object	バッチにアタッチできるキーと値のペアのセット。これは、バッチに関する追加情報を構造化された形式で格納する場合に役立ちます。
object	TypeDiscriminator	TypeDiscriminator オブジェクトの型を定義します。
output_file_id	string	正常に実行された要求の出力を含むファイルの ID。
request_counts	BatchRequestCounts	BatchRequestCounts 要求は、バッチ内のさまざまな状態にカウントされます。
status	BatchStatus	BatchStatus バッチの状態。

BatchErrorData

Object

BatchErrorData

名前	型	説明
code	string	エラーの種類を識別するエラーコード。
line	string	エラーが発生した入力ファイルの行番号 (該当する場合は null にすることができます)。
message	string	エラーの詳細を提供する、人間が判読できるメッセージ。
param	string	エラーの原因となったパラメーターの名前 (該当する場合は null にすることができます)。

BatchErrors

Object

BatchErrors

名前	型	説明
data	BatchErrorData	BatchErrorData バッチ内のエラーのエラー情報。
object	string	errors オブジェクトの型。これは常に 'list' です。

BatchesList

Object

BatchList

名前	型	説明
data	Batch[]	項目の一覧。
first_id	string	返されるバッチの一覧の最初のバッチの ID。
has_more	boolean	リストに返される要素より多くの要素が含まれているかどうかを示す値。
last_id	string	返されるバッチの一覧の最後のバッチの ID。
object	TypeDiscriminator	TypeDiscriminator オブジェクトの型を定義します。

BatchRequestCounts

Object

BatchRequestCounts

名前	型	説明
completed	integer	バッチ内で正常に完了した要求の数。
failed	integer	失敗したバッチ内の要求の数。
total	integer	バッチ内の要求の合計数。

BatchStatus

列挙

BatchStatus

値	説明
cancelled	バッチが取り消されました。
cancelling	バッチの取り消しが開始されました。
completed	バッチが完了し、結果の準備が整いました。
expired	バッチは 24 時間以内に完了できませんでした。
failed	入力ファイルが検証プロセスに失敗しました。
finalizing	バッチが完了し、結果が準備されています。
in_progress	入力ファイルが正常に検証され、バッチが現在実行されています。
validating	バッチを開始する前に、入力ファイルが検証されています。

Error

Object

エラー

名前	型	説明
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 minLength: 1	このエラーのメッセージ。
target	string	エラーが発生した場所 (使用可能な場合)。

ErrorCode

列挙

ErrorCode

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

ErrorResponse

Object

ErrorResponse

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

InnerError

Object

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

列挙

InnerErrorCode

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

TypeDiscriminator

列挙

TypeDiscriminator

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

次の方法で共有

Batch - List

URI パラメーター

要求ヘッダー

応答

セキュリティ

api-key

例

Getting all batches owned by this account.

要求のサンプル

応答のサンプル

定義

Batch

BatchErrorData

BatchErrors

BatchesList

BatchRequestCounts

BatchStatus

Error

ErrorCode

ErrorResponse

InnerError

InnerErrorCode

TypeDiscriminator