Batch

Buat Message Batch

MessageBatch Messages.Batches.Create(parameters, cancellationToken = default)

POST/v1/messages/batches

Kirim batch permintaan pembuatan Message.

Ambil Message Batch

MessageBatch Messages.Batches.Retrieve(parameters, cancellationToken = default)

GET/v1/messages/batches/{message_batch_id}

Endpoint ini idempoten dan dapat digunakan untuk melakukan polling penyelesaian Message Batch. Untuk mengakses hasil Message Batch, buat permintaan ke field results_url dalam respons.

Daftar Message Batch

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

GET/v1/messages/batches

Daftar semua Message Batch dalam sebuah Workspace. Batch yang paling baru dibuat dikembalikan terlebih dahulu.

Batalkan Message Batch

MessageBatch Messages.Batches.Cancel(parameters, cancellationToken = default)

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

Batch dapat dibatalkan kapan saja sebelum pemrosesan berakhir. Setelah pembatalan dimulai, batch memasuki status canceling, dan pada saat itu sistem dapat menyelesaikan permintaan yang sedang berjalan dan tidak dapat diinterupsi sebelum memfinalisasi pembatalan.

Hapus Message Batch

DeletedMessageBatch Messages.Batches.Delete(parameters, cancellationToken = default)

DELETE/v1/messages/batches/{message_batch_id}

Ambil hasil Message Batch

MessageBatchIndividualResponse Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)

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

Melakukan streaming hasil Message Batch sebagai file .jsonl.

Models

class DeletedMessageBatch { 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 MessageBatch { Type = "message_batch"; ID; ArchivedAt; /* 7 more */ }

class MessageBatchCanceledResult { Type = "canceled"; }

JsonElement Type = "canceled"

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

JsonElement Type = "errored"

required ErrorResponse Error

JsonElement Type = "error"

required ErrorObject Error

One of the following:

required string? RequestID

class MessageBatchExpiredResult { Type = "expired"; }

JsonElement 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.

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 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 */ }

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 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; }

JsonElement Type = "succeeded"

required Message Message