Пакеты

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

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

POST/v1/messages/batches

Отправьте пакет запросов на создание сообщений.

Получить пакет сообщений

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

GET/v1/messages/batches/{message_batch_id}

Эта конечная точка идемпотентна и может использоваться для опроса завершения пакета сообщений. Чтобы получить доступ к результатам пакета сообщений, выполните запрос по адресу, указанному в поле results_url ответа.

Список пакетов сообщений

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

GET/v1/messages/batches

Получите список всех пакетов сообщений в рабочем пространстве. Последние созданные пакеты возвращаются первыми.

Отменить пакет сообщений

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

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

Пакеты можно отменить в любой момент до окончания обработки. После инициирования отмены пакет переходит в состояние canceling, в котором система может завершить все выполняющиеся непрерываемые запросы перед окончательной отменой.

Удалить пакет сообщений

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

DELETE/v1/messages/batches/{message_batch_id}

Удалите пакет сообщений.

Получить результаты пакета сообщений

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

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

Передаёт результаты пакета сообщений в потоковом режиме в виде файла .jsonl.

Models

class BetaDeletedMessageBatch { 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 BetaMessageBatch { type = "message_batch"; id; archivedAt; /* 7 more */ }

class BetaMessageBatchCanceledResult { type = "canceled"; }

JsonValue type = "canceled"

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

JsonValue type = "errored"

BetaErrorResponse error

JsonValue type = "error"

BetaError error

One of the following:

Optional<String> requestId

class BetaMessageBatchExpiredResult { type = "expired"; }

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

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.

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

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

JsonValue type = "succeeded"

BetaMessage message