Batch

Crea un batch di messaggi

$ ant messages:batches create

POST/v1/messages/batches

Invia un batch di richieste di creazione di messaggi.

Recupera un batch di messaggi

$ ant messages:batches retrieve

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

$ ant messages:batches list

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

$ ant messages:batches cancel

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

$ ant messages:batches delete

DELETE/v1/messages/batches/{message_batch_id}

Recupera i risultati di un batch di messaggi

$ ant messages:batches results

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

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

Models

deleted_message_batch: object{ 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.

message_batch: object{ type: "message_batch", id, archived_at, 7 more }

message_batch_canceled_result: object{ type: "canceled" }

type: "canceled"

message_batch_errored_result: object{ type: "errored", error }

message_batch_expired_result: object{ type: "expired" }

type: "expired"

message_batch_individual_response: object{ custom_id, result }

This is a single line in the response .jsonl file and does not represent the response as a whole.

message_batch_request_counts: object{ canceled, errored, expired, 2 more }

canceled: number

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

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

errored: number

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

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

expired: number

Number of requests in the Message Batch that have expired.

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

processing: number

Number of requests in the Message Batch that are processing.

succeeded: number

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

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

message_batch_result: MessageBatchSucceededResult or MessageBatchErroredResult or MessageBatchCanceledResult or 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.

message_batch_succeeded_result: object{ type: "succeeded", message }