results() — anthropic-sdk-python Function Reference

Architecture documentation for the results() function in batches.py from the anthropic-sdk-python codebase.

Function python AnthropicClient SyncAPI calls 2 called by 1

Entity Profile

AnthropicClient→ SyncAPI→ results() — anthropic-sdk-python Function Reference

Dependency Diagram

graph TD
  67be316c_9863_b4bd_9bbc_d8e337c703db["results()"]
  e2cc954c_b743_44af_8834_77533ae996fd["Batches"]
  67be316c_9863_b4bd_9bbc_d8e337c703db -->|defined in| e2cc954c_b743_44af_8834_77533ae996fd
  152e22b1_8e3c_0832_4a29_9c2ada3d5f79["results()"]
  152e22b1_8e3c_0832_4a29_9c2ada3d5f79 -->|calls| 67be316c_9863_b4bd_9bbc_d8e337c703db
  0751e31f_8bae_63a0_44b9_22ed73da9d12["retrieve()"]
  67be316c_9863_b4bd_9bbc_d8e337c703db -->|calls| 0751e31f_8bae_63a0_44b9_22ed73da9d12
  152e22b1_8e3c_0832_4a29_9c2ada3d5f79["results()"]
  67be316c_9863_b4bd_9bbc_d8e337c703db -->|calls| 152e22b1_8e3c_0832_4a29_9c2ada3d5f79
  style 67be316c_9863_b4bd_9bbc_d8e337c703db fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/anthropic/resources/beta/messages/batches.py lines 350–413

    def results(
        self,
        message_batch_id: str,
        *,
        betas: List[AnthropicBetaParam] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> JSONLDecoder[BetaMessageBatchIndividualResponse]:
        """
        Streams the results of a Message Batch as a `.jsonl` file.

        Each line in the file is a JSON object containing the result of a single request
        in the Message Batch. Results are not guaranteed to be in the same order as
        requests. Use the `custom_id` field to match results to requests.

        Learn more about the Message Batches API in our
        [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing)

        Args:
          message_batch_id: ID of the Message Batch.

          betas: Optional header to specify the beta version(s) you want to use.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not message_batch_id:
            raise ValueError(f"Expected a non-empty value for `message_batch_id` but received {message_batch_id!r}")

        batch = self.retrieve(message_batch_id=message_batch_id)
        if not batch.results_url:
            raise AnthropicError(
                f"No `results_url` for the given batch; Has it finished processing? {batch.processing_status}"
            )

        extra_headers = {"Accept": "application/binary", **(extra_headers or {})}
        extra_headers = {
            **strip_not_given(
                {
                    "anthropic-beta": ",".join(chain((str(e) for e in betas), ["message-batches-2024-09-24"]))
                    if is_given(betas)
                    else not_given
                }
            ),
            **(extra_headers or {}),
        }
        extra_headers = {"anthropic-beta": "message-batches-2024-09-24", **(extra_headers or {})}
        return self._get(
            batch.results_url,
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=JSONLDecoder[BetaMessageBatchIndividualResponse],
            stream=True,
        )