TsgcHTTP_API_Anthropic › Métodos › CancelBatch

CancelBatch Method

Cancela um Message Batch em andamento na API da Anthropic

Sintaxe

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parâmetros

Name	Type	Descrição
aBatchId	const string	Identificador do lote a cancelar, normalmente começando com msgbatch_.

Valor de retorno

Descritor de batch atualizado com seu novo ProcessingStatus definido como canceling ou ended (TsgcAnthropicClass_Response_Batch)

Observações

Envia uma requisição POST /v1/messages/batches/{id}/cancel à API da Anthropic. As requisições que já começaram a ser processadas dentro do batch ainda serão cobradas; as requisições não processadas serão abortadas. O header anthropic-version de AnthropicOptions é incluído automaticamente. O objeto retornado deve ser liberado pelo chamador.

Exemplo

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

Voltar para Métodos