バッチ

メッセージバッチを作成

MessageBatch messages().batches().create(params, requestOptions = RequestOptions.none())

POST/v1/messages/batches

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

メッセージバッチを取得

MessageBatch messages().batches().retrieve(params = BatchRetrieveParams.none(), requestOptions = RequestOptions.none())

GET/v1/messages/batches/{message_batch_id}

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

メッセージバッチの一覧

BatchListPage messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())

GET/v1/messages/batches

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

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

MessageBatch messages().batches().cancel(params = BatchCancelParams.none(), requestOptions = RequestOptions.none())

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

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

メッセージバッチを削除

DeletedMessageBatch messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())

DELETE/v1/messages/batches/{message_batch_id}

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

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

StreamResponse<MessageBatchIndividualResponse> messages().batches().resultsStreaming(params = BatchResultsParams.none(), requestOptions = RequestOptions.none())

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

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

Models

class DeletedMessageBatch { type = "message_batch_deleted"; id; }

JsonValue type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

String id

ID of the Message Batch.

class MessageBatch { type = "message_batch"; id; archivedAt; /* 7 more */ }

class MessageBatchCanceledResult { type = "canceled"; }

JsonValue type = "canceled"

class MessageBatchErroredResult { type = "errored"; error; }

JsonValue type = "errored"

ErrorResponse error

JsonValue type = "error"

ErrorObject error

One of the following:

Optional<String> requestId

class MessageBatchExpiredResult { type = "expired"; }

JsonValue type = "expired"

class MessageBatchIndividualResponse { customId; result; }

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

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.

MessageBatchResult 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 MessageBatchRequestCounts { canceled; errored; expired; /* 2 more */ }

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.

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.

long expired

Number of requests in the Message Batch that have expired.

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

long processing

Number of requests in the Message Batch that are processing.

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 MessageBatchResult: 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 MessageBatchSucceededResult { type = "succeeded"; message; }

JsonValue type = "succeeded"

Message message