cancel() — anthropic-sdk-python Function Reference

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

Function python AnthropicClient AsyncAPI calls 1 called by 1

Entity Profile

AnthropicClient→ AsyncAPI→ cancel() — anthropic-sdk-python Function Reference

Dependency Diagram

graph TD
  031a03ad_95a0_8ae5_8948_03c66e0b92c7["cancel()"]
  e2cc954c_b743_44af_8834_77533ae996fd["Batches"]
  031a03ad_95a0_8ae5_8948_03c66e0b92c7 -->|defined in| e2cc954c_b743_44af_8834_77533ae996fd
  ecbd3b45_eca8_c03d_05f0_6940ca6cc72a["cancel()"]
  ecbd3b45_eca8_c03d_05f0_6940ca6cc72a -->|calls| 031a03ad_95a0_8ae5_8948_03c66e0b92c7
  ecbd3b45_eca8_c03d_05f0_6940ca6cc72a["cancel()"]
  031a03ad_95a0_8ae5_8948_03c66e0b92c7 -->|calls| ecbd3b45_eca8_c03d_05f0_6940ca6cc72a
  style 031a03ad_95a0_8ae5_8948_03c66e0b92c7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/anthropic/resources/beta/messages/batches.py lines 289–348

    def cancel(
        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,
    ) -> BetaMessageBatch:
        """Batches may be canceled any time before processing ends.

        Once cancellation is
        initiated, the batch enters a `canceling` state, at which time the system may
        complete any in-progress, non-interruptible requests before finalizing
        cancellation.

        The number of canceled requests is specified in `request_counts`. To determine
        which requests were canceled, check the individual results within the batch.
        Note that cancellation may not result in any canceled requests if they were
        non-interruptible.

        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}")
        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._post(
            f"/v1/messages/batches/{message_batch_id}/cancel?beta=true",
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=BetaMessageBatch,
        )