TsgcHTTP_API_Anthropic › Methoden › CancelBatch

CancelBatch Methode

Bricht einen laufenden Message Batch auf der Anthropic-API ab

Syntax

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parameter

Name	Typ	Beschreibung
aBatchId	const string	Bezeichner des zu stornierenden Batches, typischerweise beginnend mit msgbatch_.

Rückgabewert

Aktualisierter Batch-Deskriptor mit seinem neuen ProcessingStatus, gesetzt auf canceling oder ended (TsgcAnthropicClass_Response_Batch)

Hinweise

Sendet eine POST /v1/messages/batches/{id}/cancel-Anfrage an die Anthropic-API. Anfragen, deren Verarbeitung innerhalb des Batches bereits begonnen hat, werden dennoch abgerechnet; nicht verarbeitete Anfragen werden abgebrochen. Der anthropic-version-Header aus AnthropicOptions wird automatisch eingefügt. Das zurückgegebene Objekt muss vom Aufrufer freigegeben werden.

Beispiel

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

Zurück zu Methoden