バッチ

メッセージバッチを作成

client.messages.batches.create(params, options?): MessageBatch

POST/v1/messages/batches

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

メッセージバッチを取得

client.messages.batches.retrieve(messageBatchID, params?, options?): MessageBatch

GET/v1/messages/batches/{message_batch_id}

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

メッセージバッチの一覧

client.messages.batches.list(params?, options?): Page<MessageBatch>

GET/v1/messages/batches

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

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

client.messages.batches.cancel(messageBatchID, params?, options?): MessageBatch

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

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

メッセージバッチを削除

client.messages.batches.delete(messageBatchID, params?, options?): DeletedMessageBatch

DELETE/v1/messages/batches/{message_batch_id}

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

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

client.messages.batches.results(messageBatchID, params?, options?): MessageBatchIndividualResponse | Stream<MessageBatchIndividualResponse>

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

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

Models

interface DeletedMessageBatch { type: "message_batch_deleted"; id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: string

ID of the Message Batch.

interface MessageBatch { type: "message_batch"; id; archived_at; /* 7 more */ }

interface MessageBatchCanceledResult { type: "canceled" }

type: "canceled"

defaultcanceled

interface MessageBatchErroredResult { type: "errored"; error }

type: "errored"

defaulterrored

error: ErrorResponse { type: "error"; error; request_id }

type: "error"

defaulterror

error: ErrorObject

One of the following:

request_id: string | null

interface MessageBatchExpiredResult { type: "expired" }

type: "expired"

defaultexpired

interface MessageBatchIndividualResponse { custom_id; result }

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

custom_id: string

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.

result: MessageBatchResult

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:

interface MessageBatchRequestCounts { canceled; errored; expired; /* 2 more */ }

canceled: number

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

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

default0

errored: number

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

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

default0

expired: number

Number of requests in the Message Batch that have expired.

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

default0

processing: number

Number of requests in the Message Batch that are processing.

default0

succeeded: number

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

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

default0

type MessageBatchResult = MessageBatchSucceededResult | MessageBatchErroredResult | MessageBatchCanceledResult | MessageBatchExpiredResult

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:

interface MessageBatchSucceededResult { type: "succeeded"; message }

type: "succeeded"

defaultsucceeded

message: Message { type: "message"; id; container; /* 8 more */ }