TsgcHTTP_API_Anthropic › Méthodes › CancelBatch

CancelBatch Méthode

Annule un lot de messages en cours sur l'API Anthropic

Syntaxe

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Paramètres

Nom	Type	Description
aBatchId	const string	Identifiant du lot à annuler, commençant généralement par msgbatch_.

Valeur de retour

Descripteur de lot mis à jour avec son nouveau ProcessingStatus défini à en cours d'annulation ou terminé (TsgcAnthropicClass_Response_Batch)

Remarques

Envoie une requête POST /v1/messages/batches/{id}/cancel à l'API Anthropic. Les requêtes qui ont déjà commencé à être traitées dans le lot seront quand même facturées ; les requêtes non traitées seront annulées. L'en-tête anthropic-version de AnthropicOptions est inclus automatiquement. L'objet retourné doit être libéré par l'appelant.

Exemple

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

Retour aux méthodes