バッチ

メッセージバッチを作成

BetaMessageBatch Beta.Messages.Batches.Create(parameters, cancellationToken = default)

POST/v1/messages/batches

メッセージ作成リクエストのバッチを送信します。

メッセージバッチを取得

BetaMessageBatch Beta.Messages.Batches.Retrieve(parameters, cancellationToken = default)

GET/v1/messages/batches/{message_batch_id}

このエンドポイントはべき等であり、メッセージバッチの完了をポーリングするために使用できます。メッセージバッチの結果にアクセスするには、レスポンス内のresults_urlフィールドに対してリクエストを行ってください。

メッセージバッチの一覧

BatchListPage Beta.Messages.Batches.List(parameters, cancellationToken = default)

GET/v1/messages/batches

ワークスペース内のすべてのメッセージバッチを一覧表示します。最も新しく作成されたバッチが最初に返されます。

メッセージバッチをキャンセル

BetaMessageBatch Beta.Messages.Batches.Cancel(parameters, cancellationToken = default)

POST/v1/messages/batches/{message_batch_id}/cancel

バッチは処理が終了する前であればいつでもキャンセルできます。キャンセルが開始されると、バッチはcanceling状態になり、この間にシステムはキャンセルを確定する前に、進行中の中断不可能なリクエストを完了させる場合があります。

メッセージバッチを削除

BetaDeletedMessageBatch Beta.Messages.Batches.Delete(parameters, cancellationToken = default)

DELETE/v1/messages/batches/{message_batch_id}

メッセージバッチを削除します。

メッセージバッチの結果を取得

BetaMessageBatchIndividualResponse Beta.Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)

GET/v1/messages/batches/{message_batch_id}/results

メッセージバッチの結果を.jsonlファイルとしてストリーミングします。

Models

class BetaDeletedMessageBatch { Type = "message_batch_deleted"; ID; }

JsonElement Type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

required string ID

ID of the Message Batch.

class BetaMessageBatch { Type = "message_batch"; ID; ArchivedAt; /* 7 more */ }

class BetaMessageBatchCanceledResult { Type = "canceled"; }

JsonElement Type = "canceled"

class BetaMessageBatchErroredResult { Type = "errored"; Error; }

JsonElement Type = "errored"

required BetaErrorResponse Error

JsonElement Type = "error"

required BetaError Error

One of the following:

required string? RequestID

class BetaMessageBatchExpiredResult { Type = "expired"; }

JsonElement Type = "expired"

class BetaMessageBatchIndividualResponse { CustomID; Result; }

This is a single line in the response .jsonl file and does not represent the response as a whole.

required string CustomID

Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

Must be unique for each request within the Message Batch.

required BetaMessageBatchResult Result

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:

class BetaMessageBatchRequestCounts { Canceled; Errored; Expired; /* 2 more */ }

required long Canceled

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

required long Errored

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

required long Expired

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

required long Processing

Number of requests in the Message Batch that are processing.

required long Succeeded

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

class BetaMessageBatchResult: union

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

class BetaMessageBatchSucceededResult { Type = "succeeded"; Message; }

JsonElement Type = "succeeded"

required BetaMessage Message