Lotes

Criar um lote de mensagens

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

POST/v1/messages/batches

Envie um lote de solicitações de criação de mensagens.

Recuperar um lote de mensagens

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

GET/v1/messages/batches/{message_batch_id}

Este endpoint é idempotente e pode ser usado para fazer polling da conclusão de um lote de mensagens. Para acessar os resultados de um lote de mensagens, faça uma solicitação para o campo results_url na resposta.

Listar lotes de mensagens

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

GET/v1/messages/batches

Liste todos os lotes de mensagens em um Workspace. Os lotes criados mais recentemente são retornados primeiro.

Cancelar um lote de mensagens

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

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

Os lotes podem ser cancelados a qualquer momento antes do término do processamento. Depois que o cancelamento é iniciado, o lote entra em um estado canceling, momento em que o sistema pode concluir quaisquer solicitações em andamento e não interrompíveis antes de finalizar o cancelamento.

Excluir um lote de mensagens

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

DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens

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

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

Faz streaming dos resultados de um lote de mensagens como um arquivo .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