TsgcHTTP_API_AnthropicMétodos › CancelBatch

CancelBatch Método

Cancela un lote de mensajes en curso en la API de Anthropic

Sintaxis

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parámetros

NombreTipoDescripción
aBatchIdconst stringIdentificador del lote a cancelar, que normalmente comienza con msgbatch_.

Valor de Retorno

Descriptor de lote actualizado con su nuevo ProcessingStatus establecido en cancelando o finalizado (TsgcAnthropicClass_Response_Batch)

Observaciones

Envía una solicitud POST /v1/messages/batches/{id}/cancel a la API de Anthropic. Las solicitudes que ya hayan comenzado a procesarse dentro del lote seguirán siendo facturadas; las solicitudes no procesadas serán abortadas. La cabecera anthropic-version de AnthropicOptions se incluye automáticamente. El objeto devuelto debe ser liberado por el llamador.

Ejemplo

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

Volver a Métodos