擷取訊息批次結果

client.messages.batches.results(messageBatchID, params?, options?): MessageBatchIndividualResponse | Stream<MessageBatchIndividualResponse>

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

以 .jsonl 檔案的形式串流傳輸訊息批次的結果。

檔案中的每一行都是一個 JSON 物件，包含訊息批次中單一請求的結果。結果的順序不保證與請求的順序相同。請使用 custom_id 欄位將結果與請求配對。

在我們的使用者指南中進一步瞭解 Message Batches API

Parameters

messageBatchID: string⁠Path

ID of the Message Batch.

params: BatchResultsParams { workspace_id }

workspace_id?: string⁠Header

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

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

擷取訊息批次結果

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const messageBatchIndividualResponse = await client.messages.batches.results(
  "message_batch_id"
);

console.log(messageBatchIndividualResponse.custom_id);