Batch

Crea un batch di messaggi

messages.batches.create(**kwargs) -> MessageBatch

POST/v1/messages/batches

Invia un batch di richieste di creazione di messaggi.

Recupera un batch di messaggi

messages.batches.retrieve(message_batch_id, **kwargs) -> MessageBatch

GET/v1/messages/batches/{message_batch_id}

Questo endpoint è idempotente e può essere utilizzato per eseguire il polling del completamento di un batch di messaggi. Per accedere ai risultati di un batch di messaggi, effettua una richiesta all'URL indicato nel campo results_url della risposta.

Elenca i batch di messaggi

messages.batches.list(**kwargs) -> Page<MessageBatch>

GET/v1/messages/batches

Elenca tutti i batch di messaggi all'interno di un Workspace. I batch creati più di recente vengono restituiti per primi.

Annulla un batch di messaggi

messages.batches.cancel(message_batch_id, **kwargs) -> MessageBatch

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

I batch possono essere annullati in qualsiasi momento prima del termine dell'elaborazione. Una volta avviato l'annullamento, il batch entra nello stato canceling, durante il quale il sistema può completare eventuali richieste in corso non interrompibili prima di finalizzare l'annullamento.

Elimina un batch di messaggi

messages.batches.delete(message_batch_id, **kwargs) -> DeletedMessageBatch

DELETE/v1/messages/batches/{message_batch_id}

Recupera i risultati di un batch di messaggi

messages.batches.results_streaming(message_batch_id, **kwargs) -> JsonLStream<MessageBatchIndividualResponse>

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

Trasmette in streaming i risultati di un batch di messaggi come file .jsonl.

Models

class DeletedMessageBatch { type: :message_batch_deleted, id }

type: :message_batch_deleted

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: String

ID of the Message Batch.

class MessageBatch { type: :message_batch, id, archived_at, 7 more }

class MessageBatchCanceledResult { type: :canceled }

type: :canceled

class MessageBatchErroredResult { type: :errored, error }

type: :errored

error: ErrorResponse { type: :error, error, request_id }

type: :error

error: ErrorObject

One of the following:

request_id: String

class MessageBatchExpiredResult { type: :expired }

type: :expired

class 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:

class MessageBatchRequestCounts { canceled, errored, expired, 2 more }

canceled: Integer

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

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

errored: Integer

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

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

expired: Integer

Number of requests in the Message Batch that have expired.

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

processing: Integer

Number of requests in the Message Batch that are processing.

succeeded: Integer

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

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

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:

class MessageBatchSucceededResult { type: :succeeded, message }

type: :succeeded

message: Message { type: :message, id, container, 8 more }