`vllm.entrypoints.anthropic.protocol` ¶

Pydantic models for Anthropic API protocol.

Classes:

AnthropicContentBlock –

Content block in message.
AnthropicContextManagement –

Context management information for token counting.
AnthropicCountTokensRequest –

Anthropic messages.count_tokens request.
AnthropicCountTokensResponse –

Anthropic messages.count_tokens response.
AnthropicDelta –

Delta for streaming responses.
AnthropicError –

Error structure for Anthropic API.
AnthropicErrorResponse –

Error response structure for Anthropic API.
AnthropicJsonOutputFormat –

JSON output format configuration.
AnthropicMessage –

Message structure.
AnthropicMessagesRequest –

Anthropic Messages API request.
AnthropicMessagesResponse –

Anthropic Messages API response.
AnthropicOutputConfig –

Configuration options for the model's output, such as the output format.
AnthropicStreamEvent –

Streaming event.
AnthropicThinkingConfigAdaptive –

Extended thinking whose depth the model chooses.
AnthropicThinkingConfigEnabled –

Extended thinking with a fixed token budget.
AnthropicTool –

Tool definition.
AnthropicToolChoice –

Tool Choice definition.
AnthropicUsage –

Token usage information.

`AnthropicContentBlock` ¶

Bases: BaseModel

Content block in message.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicContentBlock(BaseModel):
    """Content block in message."""

    type: Literal[
        "text",
        "image",
        "tool_use",
        "tool_result",
        "tool_reference",
        "thinking",
        "redacted_thinking",
    ]
    text: str | None = None
    # For image content
    source: dict[str, Any] | None = None
    # For tool use/result
    id: str | None = None
    tool_use_id: str | None = None
    name: str | None = None
    input: dict[str, Any] | None = None
    content: str | list[dict[str, Any]] | None = None
    is_error: bool | None = None
    # For tool_reference content
    tool_name: str | None = None
    # For thinking content
    thinking: str | None = None
    signature: str | None = None
    # For redacted thinking content (safety-filtered by the API)
    data: str | None = None

`AnthropicContextManagement` ¶

Bases: BaseModel

Context management information for token counting.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicContextManagement(BaseModel):
    """Context management information for token counting."""

    original_input_tokens: int

`AnthropicCountTokensRequest` ¶

Bases: BaseModel

Anthropic messages.count_tokens request.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicCountTokensRequest(BaseModel):
    """Anthropic messages.count_tokens request."""

    model: str
    messages: list[AnthropicMessage]
    system: str | list[AnthropicContentBlock] | None = None
    tool_choice: AnthropicToolChoice | None = None
    tools: list[AnthropicTool] | None = None

    # vLLM-specific fields that are not in Anthropic spec
    chat_template_kwargs: dict[str, Any] | None = Field(
        default=None,
        description=(
            "Additional keyword args to pass to the chat template renderer. "
            "Will be accessible by the template."
        ),
    )

    @field_validator("model")
    @classmethod
    def validate_model(cls, v):
        if not v:
            raise ValueError("Model is required")
        return v

`AnthropicCountTokensResponse` ¶

Bases: BaseModel

Anthropic messages.count_tokens response.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicCountTokensResponse(BaseModel):
    """Anthropic messages.count_tokens response."""

    input_tokens: int
    context_management: AnthropicContextManagement | None = None

`AnthropicDelta` ¶

Bases: BaseModel

Delta for streaming responses.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicDelta(BaseModel):
    """Delta for streaming responses."""

    type: (
        Literal["text_delta", "input_json_delta", "thinking_delta", "signature_delta"]
        | None
    ) = None
    text: str | None = None
    thinking: str | None = None
    partial_json: str | None = None
    signature: str | None = None

    # Message delta
    stop_reason: (
        Literal["end_turn", "max_tokens", "stop_sequence", "tool_use"] | None
    ) = None
    stop_sequence: str | None = None

`AnthropicError` ¶

Bases: BaseModel

Error structure for Anthropic API.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicError(BaseModel):
    """Error structure for Anthropic API."""

    type: str
    message: str

`AnthropicErrorResponse` ¶

Bases: BaseModel

Error response structure for Anthropic API.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicErrorResponse(BaseModel):
    """Error response structure for Anthropic API."""

    type: Literal["error"] = "error"
    error: AnthropicError

`AnthropicJsonOutputFormat` ¶

Bases: BaseModel

JSON output format configuration.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicJsonOutputFormat(BaseModel):
    """JSON output format configuration."""

    json_schema: dict[str, Any] | None = Field(default=None, alias="schema")
    type: Literal["json_schema"] = "json_schema"

`AnthropicMessage` ¶

Bases: BaseModel

Message structure.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicMessage(BaseModel):
    """Message structure."""

    role: Literal["user", "assistant", "system"]
    content: str | list[AnthropicContentBlock]

`AnthropicMessagesRequest` ¶

Bases: BaseModel

Anthropic Messages API request.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicMessagesRequest(BaseModel):
    """Anthropic Messages API request."""

    model: str
    messages: list[AnthropicMessage]
    max_tokens: int
    metadata: dict[str, Any] | None = None
    output_config: AnthropicOutputConfig | None = None
    thinking: AnthropicThinkingConfig | None = None
    stop_sequences: (
        Annotated[list[str], Field(max_length=envs.VLLM_MAX_STOP_STRINGS)] | None
    ) = None
    stream: bool | None = False
    system: str | list[AnthropicContentBlock] | None = None
    temperature: float | None = None
    tool_choice: AnthropicToolChoice | None = None
    tools: list[AnthropicTool] | None = None
    top_k: int | None = None
    top_p: float | None = None

    # vLLM-specific fields that are not in Anthropic spec
    cache_salt: str | None = Field(
        default=None,
        min_length=1,
        max_length=1024,
        description=(
            "If specified, the prefix cache will be salted with the provided "
            "string to prevent an attacker to guess prompts in multi-user "
            "environments. The salt should be random, protected from "
            "access by 3rd parties, and long enough to be "
            "unpredictable (e.g., 43 characters base64-encoded, corresponding "
            "to 256 bit)."
        ),
    )
    kv_transfer_params: dict[str, Any] | None = Field(
        default=None,
        description="KVTransfer parameters used for disaggregated serving.",
    )
    ec_transfer_params: dict[str, Any] | None = Field(
        default=None,
        description=(
            "ECTransfer parameters used for encoder-cache disaggregated serving."
        ),
    )
    vllm_xargs: dict[str, str | int | float | list[str | int | float]] | None = Field(
        default=None,
        description=(
            "Additional request parameters with (list of) string or "
            "numeric values, used by custom extensions."
        ),
    )
    chat_template_kwargs: dict[str, Any] | None = Field(
        default=None,
        description=(
            "Additional keyword args to pass to the chat template renderer. "
            "Will be accessible by the template."
        ),
    )

    @field_validator("model")
    @classmethod
    def validate_model(cls, v):
        if not v:
            raise ValueError("Model is required")
        return v

    @field_validator("max_tokens")
    @classmethod
    def validate_max_tokens(cls, v):
        if v <= 0:
            raise ValueError("max_tokens must be positive")
        return v

    @model_validator(mode="after")
    def validate_thinking_budget(self) -> "AnthropicMessagesRequest":
        # P/D prefill legs are sent with max_tokens=1 and never decode; the
        # decode leg carries the client's max_tokens and is still checked.
        if self.kv_transfer_params and self.kv_transfer_params.get("do_remote_decode"):
            return self
        if (
            isinstance(self.thinking, AnthropicThinkingConfigEnabled)
            and self.thinking.budget_tokens >= self.max_tokens
        ):
            raise ValueError("thinking.budget_tokens must be less than max_tokens")
        return self

`AnthropicMessagesResponse` ¶

Bases: BaseModel

Anthropic Messages API response.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicMessagesResponse(BaseModel):
    """Anthropic Messages API response."""

    id: str
    type: Literal["message"] = "message"
    role: Literal["assistant"] = "assistant"
    content: list[AnthropicContentBlock]
    model: str
    stop_reason: (
        Literal["end_turn", "max_tokens", "stop_sequence", "tool_use"] | None
    ) = None
    stop_sequence: str | None = None
    usage: AnthropicUsage | None = None

    # vLLM-specific fields that are not in Anthropic spec
    kv_transfer_params: dict[str, Any] | None = Field(
        default=None, description="KVTransfer parameters."
    )
    ec_transfer_params: dict[str, Any] | None = Field(
        default=None, description="ECTransfer parameters."
    )

    def model_post_init(self, __context):
        if not self.id:
            self.id = f"msg_{int(time.time() * 1000)}"

`AnthropicOutputConfig` ¶

Bases: BaseModel

Configuration options for the model's output, such as the output format.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicOutputConfig(BaseModel):
    """Configuration options for the model's output, such as the output format."""

    effort: AnthropicEffort | None = None
    format: AnthropicJsonOutputFormat | None = None

`AnthropicStreamEvent` ¶

Bases: BaseModel

Streaming event.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicStreamEvent(BaseModel):
    """Streaming event."""

    type: Literal[
        "message_start",
        "message_delta",
        "message_stop",
        "content_block_start",
        "content_block_delta",
        "content_block_stop",
        "ping",
        "error",
    ]
    message: "AnthropicMessagesResponse | None" = None
    delta: AnthropicDelta | None = None
    content_block: AnthropicContentBlock | None = None
    index: int | None = None
    error: AnthropicError | None = None
    usage: AnthropicUsage | None = None

`AnthropicThinkingConfigAdaptive` ¶

Bases: BaseModel

Extended thinking whose depth the model chooses.

display is accepted but ignored: reasoning is always returned.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicThinkingConfigAdaptive(BaseModel):
    """Extended thinking whose depth the model chooses.

    ``display`` is accepted but ignored: reasoning is always returned.
    """

    type: Literal["adaptive"]
    display: AnthropicThinkingDisplay | None = None

`AnthropicThinkingConfigEnabled` ¶

Bases: BaseModel

Extended thinking with a fixed token budget.

display is accepted but ignored: reasoning is always returned.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicThinkingConfigEnabled(BaseModel):
    """Extended thinking with a fixed token budget.

    ``display`` is accepted but ignored: reasoning is always returned.
    """

    type: Literal["enabled"]
    budget_tokens: int = Field(ge=1024)
    display: AnthropicThinkingDisplay | None = None

`AnthropicTool` ¶

Bases: BaseModel

Tool definition.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicTool(BaseModel):
    """Tool definition."""

    name: str
    description: str | None = None
    input_schema: dict[str, Any]
    strict: bool | None = None
    defer_loading: bool | None = None

    @field_validator("input_schema")
    @classmethod
    def validate_input_schema(cls, v):
        if not isinstance(v, dict):
            raise ValueError("input_schema must be a dictionary")
        if "type" not in v:
            v["type"] = "object"  # Default to object type
        return v

`AnthropicToolChoice` ¶

Bases: BaseModel

Tool Choice definition.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicToolChoice(BaseModel):
    """Tool Choice definition."""

    type: Literal["auto", "any", "tool", "none"]
    name: str | None = None
    disable_parallel_tool_use: bool | None = None

    @model_validator(mode="after")
    def validate_name_required_for_tool(self) -> "AnthropicToolChoice":
        if self.type == "tool" and not self.name:
            raise ValueError("tool_choice.name is required when type is 'tool'")
        return self

`AnthropicUsage` ¶

Bases: BaseModel

Token usage information.

Source code in vllm/entrypoints/anthropic/protocol.py

class AnthropicUsage(BaseModel):
    """Token usage information."""

    input_tokens: int
    output_tokens: int
    cache_creation_input_tokens: int | None = None
    cache_read_input_tokens: int | None = None

vllm.entrypoints.anthropic.protocol ¶

AnthropicContentBlock ¶

AnthropicContextManagement ¶

AnthropicCountTokensRequest ¶

AnthropicCountTokensResponse ¶

AnthropicDelta ¶

AnthropicError ¶

AnthropicErrorResponse ¶

AnthropicJsonOutputFormat ¶

AnthropicMessage ¶

AnthropicMessagesRequest ¶

AnthropicMessagesResponse ¶

AnthropicOutputConfig ¶

AnthropicStreamEvent ¶

AnthropicThinkingConfigAdaptive ¶

AnthropicThinkingConfigEnabled ¶

AnthropicTool ¶

AnthropicToolChoice ¶

AnthropicUsage ¶

`vllm.entrypoints.anthropic.protocol` ¶

`AnthropicContentBlock` ¶

`AnthropicContextManagement` ¶

`AnthropicCountTokensRequest` ¶

`AnthropicCountTokensResponse` ¶

`AnthropicDelta` ¶

`AnthropicError` ¶

`AnthropicErrorResponse` ¶

`AnthropicJsonOutputFormat` ¶

`AnthropicMessage` ¶

`AnthropicMessagesRequest` ¶

`AnthropicMessagesResponse` ¶

`AnthropicOutputConfig` ¶

`AnthropicStreamEvent` ¶

`AnthropicThinkingConfigAdaptive` ¶

`AnthropicThinkingConfigEnabled` ¶

`AnthropicTool` ¶

`AnthropicToolChoice` ¶

`AnthropicUsage` ¶