Пакеты

Создать пакет сообщений

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