メッセージバッチの結果を取得

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

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

メッセージバッチの結果を.jsonlファイルとしてストリーミングします。

ファイルの各行は、メッセージバッチ内の単一リクエストの結果を含むJSONオブジェクトです。結果がリクエストと同じ順序であることは保証されません。結果とリクエストを照合するにはcustom_idフィールドを使用してください。

Message Batches APIの詳細については、ユーザーガイドをご覧ください。

Parameters

BatchResultsParams parameters

required string messageBatchID

ID of the Message Batch.

string workspaceID

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns

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:

メッセージバッチの結果を取得

BatchResultsParams parameters = new() { MessageBatchID = "message_batch_id" };

await foreach (var messageBatchIndividualResponse in client.Messages.Batches.ResultsStreaming(parameters))
{
    Console.WriteLine(messageBatchIndividualResponse);
}