TsgcHTTP_API_Anthropic › メソッド › ListBatches

ListBatches メソッド

オプションのページネーションを使用して、Anthropic ワークスペース内のすべてのメッセージバッチを一覧表示します。

構文

function ListBatches(const aLimit: Integer = 20; const aAfterId: string = ''; const aBeforeId: string = '') : TsgcAnthropicClass_Response_List_Batches;

パラメータ

名前	タイプ	説明
aLimit	const Integer	1 ページあたりに返すバッチの最大数。デフォルトは 20 です。
aAfterId	const string	Cursor：この ID のバッチより後に作成されたバッチを返します。最初のページでは空白にします。
aBeforeId	const string	カーソル：この ID を持つバッチより前に作成されたバッチを返します。無視するには空にします。

戻り値

バッチ記述子のData配列と、ページングカーソルを含む応答です（TsgcAnthropicClass_Response_List_Batches）

解説

Anthropic Message Batches APIに対してGET /v1/messages/batchesリクエストを実行し、現在のワークスペースによって送信されたすべてのバッチとその現在の処理ステータス（in_progress、ended、canceledなど）を返します。aAfterIdを使用して最初のページを超えてページングします。AnthropicOptionsからのanthropic-versionヘッダーは自動的に含まれます。返されたオブジェクトは呼び出し元が解放する必要があります。

使用例

oResponse := oAPI.ListBatches(20);
try
  for i := 0 to oResponse.Data.Count - 1 do
    Memo1.Lines.Add(oResponse.Data[i].Id + ' = ' + oResponse.Data[i].ProcessingStatus);
finally
  oResponse.Free;
end;

メソッドに戻る