CancelBatch Metoda

Anuluje trwającą partię wiadomości (Message Batch) w Anthropic API

Składnia

function CancelBatch(const aBatchId: string) : TsgcAnthropicClass_Response_Batch;

Parametry

Nazwa	Typ	Opis
`aBatchId`	`const string`	Identyfikator partii do anulowania, zazwyczaj zaczyna się od `msgbatch_`.

Wartość zwracana

Zaktualizowany deskryptor partii z nowym ProcessingStatus ustawionym na anulowanie lub zakończone (TsgcAnthropicClass_Response_Batch)

Uwagi

Wysyła żądanie POST /v1/messages/batches/{id}/cancel do API Anthropic. Żądania, które już rozpoczęły przetwarzanie w ramach paczki, nadal będą rozliczane; nieprzetworzone żądania zostaną przerwane. Nagłówek anthropic-version z AnthropicOptions jest dołączany automatycznie. Zwrócony obiekt musi zostać zwolniony przez wywołującego.

Przykład

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

Powrót do metod