Batch - Cancel

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-07-01-preview

指定されたバッチ ID で指定されたバッチの処理を取り消します。

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2024-07-01-preview

URI パラメーター

名前 / 必須 型 説明
batch-id
 path True

string

バッチの識別子。
endpoint
 path True

string

url

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。
api-version
 query True

string

要求された API バージョン。

応答

名前 型 説明
200 OK

Batch

バッチが正常に取り消されました。
Other Status Codes

ErrorResponse

エラーが発生しました。

セキュリティ

api-key

API キー認証

型: apiKey
/: header

OAuth2Auth

OAuth2 認証

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

例

Canceling a batch.

要求のサンプル

POST https://aoairesource.openai.azure.com/openai/batches/batch_72a2792ef7d24ba7b82c7fe4a37e379f/cancel?api-version=2024-07-01-preview

応答のサンプル

状態コード:
200 
{
  "object": "batch",
  "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
  "endpoint": "/chat/completions",
  "errors": null,
  "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1646126127,
  "in_progress_at": 1646126130,
  "expires_at": 1646126170,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1646126138,
  "cancelled_at": null,
  "request_counts": {
    "total": 500,
    "completed": 100,
    "failed": 5
  },
  "metadata": {
    "batch_description": "Evaluation job"
  }
}

定義

名前 説明
Batch

バッチ
BatchErrorData

BatchErrorData
BatchErrors

BatchErrors
BatchRequestCounts

BatchRequestCounts
BatchStatus

BatchStatus
Error

エラー
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
InnerError

InnerError
InnerErrorCode

InnerErrorCode
TypeDiscriminator

TypeDiscriminator

Batch

バッチ

名前 型 説明
cancelled_at

integer

このバッチが取り消されたときのタイムスタンプ (unix エポック)。
cancelling_at

integer

このバッチが取り消しを開始したときのタイムスタンプ (unix エポック)。
completed_at

integer

このバッチが完了したときのタイムスタンプ (unix エポック)。
completion_window

string

バッチを処理する期間。
created_at

integer

このバッチが作成されたときのタイムスタンプ (unix エポック)。
endpoint

string

バッチによって使用される API エンドポイント。
error_file_id

string

エラーのある要求の出力を含むファイルの ID。
errors

BatchErrors

BatchErrors
失敗したバッチの場合、エラーの原因に関する詳細情報が含まれます。
expired_at

integer

このバッチの有効期限が切れたときのタイムスタンプ (unix エポック)。
expires_at

integer

このバッチの有効期限が切れるタイムスタンプ (unix エポック)。
failed_at

integer

このバッチが失敗したときのタイムスタンプ (unix エポック)。
finalizing_at

integer

このバッチの最終処理が開始されたときのタイムスタンプ (unix エポック)。
id

string

この項目の ID。
in_progress_at

integer

このバッチの進行が開始されたときのタイムスタンプ (unix エポック)。
input_file_id

string

バッチの入力ファイルの ID。
metadata

object

バッチにアタッチできるキーと値のペアのセット。 これは、バッチに関する追加情報を構造化された形式で格納する場合に役立ちます。
object

TypeDiscriminator

TypeDiscriminator
オブジェクトの型を定義します。
output_file_id

string

正常に実行された要求の出力を含むファイルの ID。
request_counts

BatchRequestCounts

BatchRequestCounts
要求は、バッチ内のさまざまな状態にカウントされます。
status

BatchStatus

BatchStatus
バッチの状態。

BatchErrorData

BatchErrorData

名前 型 説明
code

string

エラーの種類を識別するエラー コード。
line

string

エラーが発生した入力ファイルの行番号 (該当する場合は null にすることができます)。
message

string

エラーの詳細を提供する、人間が判読できるメッセージ。
param

string

エラーの原因となったパラメーターの名前 (該当する場合は null にすることができます)。

BatchErrors

BatchErrors

名前 型 説明
data

BatchErrorData

BatchErrorData
バッチ内のエラーのエラー情報。
object

string

errors オブジェクトの型。 これは常に 'list' です。

BatchRequestCounts

BatchRequestCounts

名前 型 説明
completed

integer

バッチ内で正常に完了した要求の数。
failed

integer

失敗したバッチ内の要求の数。
total

integer

バッチ内の要求の合計数。

BatchStatus

BatchStatus

名前 型 説明
cancelled

string

バッチが取り消されました。
cancelling

string

バッチの取り消しが開始されました。
completed

string

バッチが完了し、結果の準備が整いました。
expired

string

バッチは 24 時間以内に完了できませんでした。
failed

string

入力ファイルが検証プロセスに失敗しました。
finalizing

string

バッチが完了し、結果が準備されています。
in_progress

string

入力ファイルが正常に検証され、バッチが現在実行されています。
validating

string

バッチを開始する前に、入力ファイルが検証されています。

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

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

Error

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

InnerError

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

string

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

TypeDiscriminator

TypeDiscriminator

名前 型 説明
batch

string

このオブジェクトはバッチを表します。
file

string

このオブジェクトはファイルを表します。
fine_tuning.job

string

このオブジェクトは、微調整ジョブを表します。
fine_tuning.job.checkpoint

string

このオブジェクトは、微調整ジョブのチェックポイントを表します。
fine_tuning.job.event

string

このオブジェクトは、微調整ジョブのイベントを表します。
list

string

このオブジェクトは、他のオブジェクトの一覧を表します。
model

string

このオブジェクトは、モデルを表します (基本モデルまたは微調整ジョブの結果を指定できます)。