Batches

Einen Message Batch erstellen

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

POST/v1/messages/batches

Sende einen Batch von Anfragen zur Erstellung von Nachrichten.

Einen Message Batch abrufen

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

GET/v1/messages/batches/{message_batch_id}

Dieser Endpunkt ist idempotent und kann verwendet werden, um den Abschluss eines Message Batch per Polling abzufragen. Um auf die Ergebnisse eines Message Batch zuzugreifen, sende eine Anfrage an die im Feld results_url der Antwort angegebene URL.

Message Batches auflisten

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

GET/v1/messages/batches

Liste alle Message Batches innerhalb eines Workspace auf. Die zuletzt erstellten Batches werden zuerst zurückgegeben.

Einen Message Batch abbrechen

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

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

Batches können jederzeit vor Ende der Verarbeitung abgebrochen werden. Sobald der Abbruch eingeleitet wurde, wechselt der Batch in den Zustand canceling; in dieser Zeit kann das System laufende, nicht unterbrechbare Anfragen noch abschließen, bevor der Abbruch finalisiert wird.

Einen Message Batch löschen

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

DELETE/v1/messages/batches/{message_batch_id}

Lösche einen Message Batch.

Ergebnisse eines Message Batch abrufen

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

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

Streamt die Ergebnisse eines Message Batch als .jsonl-Datei.

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