TsgcHTTP_API_Anthropic › Methods › CancelBatch

CancelBatch Metodo

Annulla un Message Batch in corso sull'API Anthropic

Sintassi

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parametri

Nome	Tipo	Descrizione
aBatchId	const string	Identificatore del batch da annullare, che tipicamente inizia con msgbatch_.

Valore restituito

Descrittore batch aggiornato con il suo nuovo ProcessingStatus impostato su canceling o ended (TsgcAnthropicClass_Response_Batch)

Note

Invia una richiesta POST /v1/messages/batches/{id}/cancel all'API Anthropic. Le richieste già in fase di elaborazione nel batch verranno comunque addebitate; le richieste non elaborate verranno interrotte. L'intestazione anthropic-version di AnthropicOptions viene inclusa automaticamente. L'oggetto restituito deve essere liberato dal chiamante.

Esempio

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

Torna ai Metodi