TsgcHTTP_API_Anthropic › メソッド › CancelBatch

CancelBatch メソッド

Anthropic API で進行中のメッセージバッチをキャンセルします

構文

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

パラメータ

名前	タイプ	説明
aBatchId	const string	キャンセルするバッチの識別子。通常 msgbatch_ で始まります。

戻り値

キャンセルまたは終了に設定された新しい ProcessingStatus を持つ更新されたバッチディスクリプター（TsgcAnthropicClass_Response_Batch）

解説

Anthropic API に POST /v1/messages/batches/{id}/cancel リクエストを送信します。バッチ内ですでに処理が開始されたリクエストは引き続き課金されます。未処理のリクエストは中止されます。AnthropicOptions の anthropic-version ヘッダーは自動的に含まれます。返されたオブジェクトは呼び出し元が解放する必要があります。

使用例

oResponse := oAPI.CancelBatch('msgbatch_01AbCdEf');
try
  ShowMessage('new status: ' + oResponse.ProcessingStatus);
finally
  oResponse.Free;
end;

メソッドに戻る