TsgcHTTP_API_Anthropic › Methoden › CancelBatch

CancelBatch Method

Annuleert een actieve Message Batch op de Anthropic API

Syntaxis

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parameters

Naam	Type	Beschrijving
aBatchId	const string	Identificatie van de batch die geannuleerd moet worden, doorgaans beginnend met msgbatch_.

Retourwaarde

Bijgewerkte batchdescriptor met de nieuwe ProcessingStatus ingesteld op annuleren of beëindigd (TsgcAnthropicClass_Response_Batch)

Opmerkingen

Verzendt een POST /v1/messages/batches/{id}/cancel-verzoek naar de Anthropic API. Verzoeken die al zijn begonnen met verwerken in de batch worden nog steeds gefactureerd; onverwerkte verzoeken worden afgebroken. De header anthropic-version uit AnthropicOptions wordt automatisch opgenomen. Het geretourneerde object moet door de aanroeper worden vrijgegeven.

Voorbeeld

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

Terug naar methoden