gllm-inference-binary 0.5.51b3__cp311-cp311-macosx_11_0_x86_64.whl

gllm_inference/lm_invoker/portkey_lm_invoker.pyi

@@ -0,0 +1,260 @@
+from _typeshed import Incomplete
+from gllm_core.event import EventEmitter as EventEmitter
+from gllm_core.schema.tool import Tool as Tool
+from gllm_core.utils.retry import RetryConfig as RetryConfig
+from gllm_inference.constants import SECONDS_TO_MILLISECONDS as SECONDS_TO_MILLISECONDS
+from gllm_inference.lm_invoker.openai_chat_completions_lm_invoker import OpenAIChatCompletionsLMInvoker as OpenAIChatCompletionsLMInvoker
+from gllm_inference.lm_invoker.schema.portkey import InputType as InputType, Key as Key
+from gllm_inference.schema import AttachmentType as AttachmentType, LMOutput as LMOutput, ModelId as ModelId, ModelProvider as ModelProvider, ResponseSchema as ResponseSchema
+from langchain_core.tools import Tool as LangChainTool
+from typing import Any
+
+MIN_THINKING_BUDGET: int
+SUPPORTED_ATTACHMENTS: Incomplete
+VALID_AUTH_METHODS: str
+logger: Incomplete
+
+class PortkeyLMInvoker(OpenAIChatCompletionsLMInvoker):
+    '''A language model invoker to interact with Portkey\'s Universal API.
+
+    This class provides support for Portkey’s Universal AI Gateway, which enables unified access to
+    multiple providers (e.g., OpenAI, Anthropic, Google, Cohere, Bedrock) via a single API key.
+    The `PortkeyLMInvoker` is compatible with all Portkey model routing configurations, including
+    model catalog entries, direct providers, and pre-defined configs.
+
+    Attributes:
+        model_id (str): The model ID of the language model.
+        model_provider (str): The provider of the language model.
+        model_name (str): The catalog name of the language model.
+        client_kwargs (dict[str, Any]): The keyword arguments for the Portkey client.
+        default_hyperparameters (dict[str, Any]): Default hyperparameters for invoking the model.
+        tools (list[Tool]): The list of tools provided to the model to enable tool calling.
+        response_schema (ResponseSchema | None): The schema of the response. If provided, the model will output a
+            structured response as defined by the schema. Supports both Pydantic BaseModel and JSON schema dictionary.
+        output_analytics (bool): Whether to output the invocation analytics.
+        retry_config (RetryConfig): The retry configuration for the language model.
+        thinking (bool): Whether to enable thinking mode for supported models.
+        thinking_budget (int): The maximum reasoning token budget for thinking mode.
+
+    Basic usage:
+        The `PortkeyLMInvoker` supports multiple authentication methods with strict precedence order.
+        Authentication methods are mutually exclusive and cannot be combined.
+
+        **Authentication Precedence (Highest to Lowest):**
+        1. **Config ID Authentication (Highest precedence)**
+           Use a pre-configured routing setup from Portkey’s dashboard.
+           ```python
+           lm_invoker = PortkeyLMInvoker(
+               portkey_api_key="<your-portkey-api-key>",
+               config="pc-openai-4f6905",
+           )
+           ```
+
+        2. **Model Catalog Authentication**
+           Provider name must match the provider name set in the model catalog.
+           More details to set up the model catalog can be found in https://portkey.ai/docs/product/model-catalog#model-catalog.
+           There are two ways to specify the model name:
+
+           2.1. Using Combined Model Name Format
+           Specify the `model_name` in \'@provider-name/model-name\' format.
+           ```python
+           lm_invoker = PortkeyLMInvoker(
+               portkey_api_key="<your-portkey-api-key>",
+               model_name="@openai-custom/gpt-4o"
+           )
+           ```
+
+           2.2. Using Separate Provider and Model Name Parameters
+           Specify the `provider` in \'@provider-name\' format and `model_name` separately.
+           ```python
+           lm_invoker = PortkeyLMInvoker(
+               portkey_api_key="<your-portkey-api-key>",
+               provider="@openai-custom",
+               model_name="gpt-4o",
+           )
+           ```
+
+        3. **Direct Provider Authentication**
+           Use the `provider` in \'provider-name\' format and `model_name` parameters.
+           ```python
+           lm_invoker = PortkeyLMInvoker(
+               portkey_api_key="<your-portkey-api-key>",
+               provider="openai",
+               model_name="gpt-4o",
+               api_key="sk-...",
+           )
+           ```
+
+    Custom Host:
+        You can also use the `custom_host` parameter to override the default host. This is available
+        for all authentication methods except for Config ID authentication.
+        ```python
+        lm_invoker = PortkeyLMInvoker(..., custom_host="https://your-custom-endpoint.com")
+        ```
+
+    Input types:
+        The `PortkeyLMInvoker` supports text, image, document, and audio inputs.
+        Non-text inputs can be passed as an `Attachment` object with the `user` role.
+
+        ```python
+        text = "What animal is in this image?"
+        image = Attachment.from_path("path/to/image.png")
+        result = await lm_invoker.invoke([text, image])
+        ```
+
+    Tool calling:
+        Tools can be provided via the `tools` parameter to enable tool invocation.
+
+        ```python
+        lm_invoker = PortkeyLMInvoker(..., tools=[tool_1, tool_2])
+        ```
+        Output example:
+        ```python
+        LMOutput(
+            response="Let me call the tools...",
+            tool_calls=[
+                ToolCall(id="123", name="tool_1", args={"key": "value"}),
+            ]
+        )
+        ```
+
+    Structured output:
+        The `response_schema` parameter enables structured responses (Pydantic BaseModel or JSON schema).
+
+        ```python
+        class Animal(BaseModel):
+            name: str
+            color: str
+        lm_invoker = PortkeyLMInvoker(..., response_schema=Animal)
+        ```
+        Output example:
+        ```python
+        LMOutput(structured_output=Animal(name="Golden retriever", color="Golden"))
+        ```
+
+    Analytics tracking:
+        When `output_analytics=True`, the invoker includes token usage, duration, and finish details.
+
+        ```python
+        LMOutput(
+            response="Golden retriever is a good dog breed.",
+            token_usage=TokenUsage(input_tokens=100, output_tokens=50),
+            duration=0.729,
+            finish_details={"finish_reason": "stop"},
+        )
+        ```
+
+        **Note:** When streaming is enabled, token usage analytics are not supported and will be `None`.
+
+    Retry and timeout:
+        The `PortkeyLMInvoker` supports retry and timeout configuration.
+        By default, the max retries is set to 0 and the timeout is set to 30.0 seconds.
+        They can be customized by providing a custom `RetryConfig` object to the `retry_config` parameter.
+
+        Retry config examples:
+        ```python
+        retry_config = RetryConfig(max_retries=0, timeout=None)  # No retry, no timeout
+        retry_config = RetryConfig(max_retries=0, timeout=10.0)  # No retry, 10.0 seconds timeout
+        retry_config = RetryConfig(max_retries=5, timeout=None)  # 5 max retries, no timeout
+        retry_config = RetryConfig(max_retries=5, timeout=10.0)  # 5 max retries, 10.0 seconds timeout
+        ```
+
+        Usage example:
+        ```python
+        lm_invoker = PortkeyLMInvoker(..., retry_config=retry_config)
+        ```
+
+    Thinking:
+        The `thinking` parameter enables enhanced reasoning capability for supported models.
+        Thinking mode allocates additional “reasoning tokens” up to `thinking_budget` (minimum 1024).
+        When enabled, the model’s reasoning trace is stored in the `reasoning` attribute.
+
+        ```python
+        lm_invoker = PortkeyLMInvoker(..., thinking=True, thinking_budget=1024)
+        ```
+        Output example:
+        ```python
+        LMOutput(
+            response="Golden retriever is a good dog breed.",
+            reasoning=[Reasoning(reasoning="Let me think about it...")],
+        )
+        ```
+
+        Streaming output example:
+        ```python
+        {"type": "thinking_start", "value": ""}
+        {"type": "thinking", "value": "Let me think "}
+        {"type": "thinking", "value": "about it..."}
+        {"type": "thinking_end", "value": ""}
+        {"type": "response", "value": "Golden retriever "}
+        {"type": "response", "value": "is a good dog breed."}
+        ```
+
+        Note: By default, the thinking token will be streamed with the legacy `EventType.DATA` event type.
+        To use the new simplified streamed event format, set the `simplify_events` parameter to `True` during
+        LM invoker initialization. The legacy event format support will be removed in v0.6.
+
+        When thinking is enabled, the amount of tokens allocated for the thinking process can be set via the
+        `thinking_budget` parameter. The `thinking_budget`:
+        1. Must be a positive integer.
+        2. Must be at least 1024.
+        3. Must be less than or equal to the model\'s maximum context length.
+        For more information, please refer to https://portkey.ai/docs/product/ai-gateway/multimodal-capabilities/thinking-mode
+
+        Setting reasoning-related parameters for non-reasoning models will raise an error.
+
+    Output types:
+        The output of the `PortkeyLMInvoker` can either be:
+        1. `str`: A simple text response.
+        2. `LMOutput`: A structured response model that may contain:
+            2.1. response (str)
+            2.2. tool_calls (list[ToolCall])
+            2.3. structured_output (dict[str, Any] | BaseModel | None)
+            2.4. token_usage (TokenUsage | None)
+            2.5. duration (float | None)
+            2.6. finish_details (dict[str, Any] | None)
+            2.7. reasoning (list[Reasoning])
+    '''
+    model_kwargs: Incomplete
+    thinking: Incomplete
+    thinking_budget: Incomplete
+    client_kwargs: Incomplete
+    client: Incomplete
+    def __init__(self, model_name: str | None = None, portkey_api_key: str | None = None, provider: str | None = None, api_key: str | None = None, config: str | None = None, custom_host: str | None = None, model_kwargs: dict[str, Any] | None = None, default_hyperparameters: dict[str, Any] | None = None, tools: list[Tool | LangChainTool] | None = None, response_schema: ResponseSchema | None = None, output_analytics: bool = False, retry_config: RetryConfig | None = None, thinking: bool | None = None, thinking_budget: int | None = None, simplify_events: bool = False) -> None:
+        """Initializes a new instance of the PortkeyLMInvoker class.
+
+        Args:
+            model_name (str | None, optional): The name of the model to use. Acceptable formats:
+                1. 'model' for direct authentication,
+                2. '@provider-slug/model' for model catalog authentication.
+                Defaults to None.
+            portkey_api_key (str | None, optional): The Portkey API key. Defaults to None, in which
+                case the `PORTKEY_API_KEY` environment variable will be used.
+            provider (str | None, optional): Provider name or catalog slug. Acceptable formats:
+                1. '@provider-slug' for model catalog authentication (no api_key needed),
+                2. 'provider' for direct authentication (requires api_key).
+                Will be combined with model_name if model name is not in the format '@provider-slug/model'.
+                Defaults to None.
+            api_key (str | None, optional): Provider's API key for direct authentication.
+                Must be used with 'provider' parameter (without '@' prefix). Not needed for catalog providers.
+                Defaults to None.
+            config (str | None, optional): Portkey config ID for complex routing configurations,
+                load balancing, or fallback scenarios. Defaults to None.
+            custom_host (str | None, optional): Custom host URL for self-hosted or custom endpoints.
+                Can be combined with catalog providers. Defaults to None.
+            model_kwargs (dict[str, Any] | None, optional): Additional model parameters and authentication.
+                Defaults to None.
+            default_hyperparameters (dict[str, Any] | None, optional): Default hyperparameters for model
+                invocation (temperature, max_tokens, etc.). Defaults to None.
+            tools (list[Tool | LangChainTool] | None, optional): Tools for enabling tool calling functionality.
+                Defaults to None.
+            response_schema (ResponseSchema | None, optional): Schema for structured output generation.
+                Defaults to None.
+            output_analytics (bool, optional): Whether to output detailed invocation analytics including
+                token usage and timing. Defaults to False.
+            retry_config (RetryConfig | None, optional): Configuration for retry behavior on failures.
+                Defaults to None.
+            thinking (bool | None, optional): Whether to enable thinking mode. Defaults to None.
+            thinking_budget (int | None, optional): Thinking budget in tokens. Defaults to None.
+            simplify_events (bool, optional): Whether to use simplified event schemas. Defaults to False.
+        """

gllm_inference/lm_invoker/schema/anthropic.pyi

@@ -0,0 +1,56 @@
+class Key:
+    """Defines valid keys in Anthropic."""
+    BUDGET_TOKENS: str
+    CONTENT: str
+    DATA: str
+    DESCRIPTION: str
+    ID: str
+    INPUT: str
+    INPUT_SCHEMA: str
+    MAX_RETRIES: str
+    MEDIA_TYPE: str
+    MAX_TOKENS: str
+    NAME: str
+    PARAMETERS: str
+    ROLE: str
+    SIGNATURE: str
+    SOURCE: str
+    STATUS: str
+    STOP_REASON: str
+    SYSTEM: str
+    TIMEOUT: str
+    THINKING: str
+    TOOLS: str
+    TOOL_CHOICE: str
+    TOOL_USE_ID: str
+    TEXT: str
+    TYPE: str
+
+class InputType:
+    """Defines valid input types in Anthropic."""
+    BASE64: str
+    ENABLED: str
+    REDACTED_THINKING: str
+    TEXT: str
+    THINKING: str
+    TOOL: str
+    TOOL_RESULT: str
+    TOOL_USE: str
+
+class OutputType:
+    """Defines valid output types in Anthropic."""
+    CANCELING: str
+    CONTENT_BLOCK_DELTA: str
+    CONTENT_BLOCK_START: str
+    CONTENT_BLOCK_STOP: str
+    ENDED: str
+    ERRORED: str
+    IN_PROGRESS: str
+    MESSAGE_STOP: str
+    REDACTED_THINKING: str
+    SUCCEEDED: str
+    TEXT: str
+    TEXT_DELTA: str
+    THINKING: str
+    THINKING_DELTA: str
+    TOOL_USE: str

gllm_inference/lm_invoker/schema/bedrock.pyi

@@ -0,0 +1,53 @@
+class Key:
+    """Defines valid keys in Bedrock."""
+    BYTES: str
+    CONTENT: str
+    CONTENT_BLOCK_INDEX: str
+    DELTA: str
+    DESCRIPTION: str
+    ERROR: str
+    CODE: str
+    FORMAT: str
+    FUNCTION: str
+    HTTP_STATUS_CODE: str
+    INFERENCE_CONFIG: str
+    INPUT: str
+    INPUT_SCHEMA: str
+    INPUT_TOKENS: str
+    JSON: str
+    MESSAGE: str
+    NAME: str
+    RESPONSE: str
+    OUTPUT: str
+    OUTPUT_TOKENS: str
+    PARAMETERS: str
+    RESPONSE_METADATA: str
+    ROLE: str
+    SOURCE: str
+    START: str
+    STOP_REASON: str
+    STREAM: str
+    SYSTEM: str
+    TEXT: str
+    TOOL: str
+    TOOLS: str
+    TOOL_CHOICE: str
+    TOOL_CONFIG: str
+    TOOL_SPEC: str
+    TOOL_USE_ID: str
+    USAGE: str
+
+class InputType:
+    """Defines valid input types in Bedrock."""
+    TEXT: str
+    TOOL_RESULT: str
+    TOOL_USE: str
+
+class OutputType:
+    """Defines valid output types in Bedrock."""
+    CONTENT_BLOCK_START: str
+    CONTENT_BLOCK_DELTA: str
+    MESSAGE_STOP: str
+    METADATA: str
+    TEXT: str
+    TOOL_USE: str

gllm_inference/lm_invoker/schema/datasaur.pyi

@@ -0,0 +1,14 @@
+class Key:
+    """Defines valid keys in Datasaur."""
+    API_KEY: str
+    BASE_URL: str
+    CONTEXTS: str
+    MAX_RETRIES: str
+    NAME: str
+    TIMEOUT: str
+    TYPE: str
+    URL: str
+
+class InputType:
+    """Defines valid input types in Datasaur."""
+    URL: str

gllm_inference/lm_invoker/schema/google.pyi

@@ -0,0 +1,24 @@
+class Key:
+    """Defines valid keys in Google."""
+    ARGS: str
+    CONTENT: str
+    FINISH_MESSAGE: str
+    FINISH_REASON: str
+    FUNCTION: str
+    FUNCTION_CALL: str
+    HTTP_OPTIONS: str
+    NAME: str
+    RETRY_OPTIONS: str
+    SYSTEM_INSTRUCTION: str
+    THINKING_CONFIG: str
+    TIMEOUT: str
+    TOOLS: str
+    RESPONSE_SCHEMA: str
+    RESPONSE_MIME_TYPE: str
+    VERTEXAI: str
+
+class InputType:
+    """Defines valid input types in Google."""
+    APPLICATION_JSON: str
+    MODEL: str
+    USER: str

gllm_inference/lm_invoker/schema/langchain.pyi

@@ -0,0 +1,23 @@
+class Key:
+    """Defines valid keys in LangChain."""
+    ARGS: str
+    ERROR_CODE: str
+    FINISH_REASON: str
+    ID: str
+    IMAGE_URL: str
+    INPUT_TOKENS: str
+    MAX_RETRIES: str
+    NAME: str
+    OUTPUT_TOKENS: str
+    PARSED: str
+    RAW: str
+    TEXT: str
+    TIMEOUT: str
+    TYPE: str
+    URL: str
+
+class InputType:
+    """Defines valid input types in LangChain."""
+    IMAGE_URL: str
+    TEXT: str
+    TOOL_CALL: str

gllm_inference/lm_invoker/schema/openai.pyi

@@ -0,0 +1,106 @@
+from enum import StrEnum
+
+class Key:
+    """Defines valid keys in OpenAI."""
+    ALLOWED_TOOLS: str
+    API_KEY: str
+    ARGS: str
+    ARGUMENTS: str
+    BASE_URL: str
+    CALL_ID: str
+    CONTAINER: str
+    CONTENT: str
+    DEFAULT: str
+    DEFS: str
+    DESCRIPTION: str
+    EFFORT: str
+    FILE_DATA: str
+    FILENAME: str
+    FORMAT: str
+    ID: str
+    IMAGE_URL: str
+    INCLUDE: str
+    INCOMPLETE_DETAILS: str
+    INSTRUCTIONS: str
+    JSON_SCHEMA: str
+    MAX_RETRIES: str
+    NAME: str
+    OUTPUT: str
+    PARAMETERS: str
+    REASON: str
+    REASONING: str
+    ROLE: str
+    SCHEMA: str
+    REQUIRE_APPROVAL: str
+    REQUIRED: str
+    SERVER_LABEL: str
+    SERVER_NAME: str
+    SERVER_URL: str
+    STATUS: str
+    STRICT: str
+    SUMMARY: str
+    TEXT: str
+    TIMEOUT: str
+    TITLE: str
+    TOOL_NAME: str
+    TOOLS: str
+    TYPE: str
+
+class InputType:
+    """Defines valid input types in OpenAI."""
+    AUTO: str
+    CODE_INTERPRETER: str
+    CODE_INTERPRETER_CALL_OUTPUTS: str
+    FUNCTION: str
+    FUNCTION_CALL: str
+    FUNCTION_CALL_OUTPUT: str
+    INPUT_FILE: str
+    INPUT_IMAGE: str
+    INPUT_TEXT: str
+    JSON_SCHEMA: str
+    MCP: str
+    MCP_CALL: str
+    NEVER: str
+    NULL: str
+    OUTPUT_TEXT: str
+    REASONING: str
+    SUMMARY_TEXT: str
+    WEB_SEARCH_PREVIEW: str
+
+class OutputType:
+    """Defines valid output types in OpenAI."""
+    CODE_INTERPRETER_CALL: str
+    CODE_INTERPRETER_CALL_DELTA: str
+    CODE_INTERPRETER_CALL_DONE: str
+    CODE_INTERPRETER_CALL_IN_PROGRESS: str
+    COMPLETED: str
+    CONTAINER_FILE_CITATION: str
+    FIND_IN_PAGE: str
+    FUNCTION_CALL: str
+    IMAGE: str
+    INCOMPLETE: str
+    ITEM_DONE: str
+    MCP_CALL: str
+    MCP_LIST_TOOLS: str
+    MESSAGE: str
+    OPEN_PAGE: str
+    REASONING: str
+    REASONING_ADDED: str
+    REASONING_DELTA: str
+    REASONING_DONE: str
+    REFUSAL: str
+    SEARCH: str
+    TEXT_DELTA: str
+    WEB_SEARCH_CALL: str
+
+class ReasoningEffort(StrEnum):
+    """Defines the reasoning effort for reasoning models."""
+    HIGH = 'high'
+    MEDIUM = 'medium'
+    LOW = 'low'
+    MINIMAL = 'minimal'
+
+class ReasoningSummary(StrEnum):
+    """Defines the reasoning summary for reasoning models."""
+    AUTO = 'auto'
+    DETAILED = 'detailed'

gllm_inference/lm_invoker/schema/openai_chat_completions.pyi

@@ -0,0 +1,62 @@
+from enum import StrEnum
+
+class Key:
+    """Defines valid keys in OpenAI Chat Completions."""
+    API_KEY: str
+    ARGUMENTS: str
+    BASE_URL: str
+    CONTENT: str
+    CHOICES: str
+    DATA: str
+    DEFS: str
+    DESCRIPTION: str
+    EFFORT: str
+    FILE: str
+    FILE_DATA: str
+    FILENAME: str
+    FINISH_REASON: str
+    FORMAT: str
+    FUNCTION: str
+    ID: str
+    IMAGE_URL: str
+    INPUT_AUDIO: str
+    JSON_SCHEMA: str
+    MAX_RETRIES: str
+    MESSAGE: str
+    NAME: str
+    PARAMETERS: str
+    RESPONSE_FORMAT: str
+    ROLE: str
+    SCHEMA: str
+    STRICT: str
+    TEXT: str
+    TIMEOUT: str
+    TITLE: str
+    TOOLS: str
+    TOOL_CALLS: str
+    TOOL_CALL_ID: str
+    TYPE: str
+    URL: str
+    USAGE: str
+    REASONING: str
+    REASONING_CONTENT: str
+    REASONING_EFFORT: str
+    SUMMARY: str
+
+class InputType:
+    """Defines valid input types in OpenAI Chat Completions."""
+    FILE: str
+    FUNCTION: str
+    IMAGE_URL: str
+    INPUT_AUDIO: str
+    JSON_SCHEMA: str
+    TEXT: str
+    TOOL: str
+    REASONING: str
+    SUMMARY_TEXT: str
+
+class ReasoningEffort(StrEnum):
+    """Defines the reasoning effort for reasoning models."""
+    HIGH = 'high'
+    MEDIUM = 'medium'
+    LOW = 'low'

gllm_inference/lm_invoker/schema/portkey.pyi

@@ -0,0 +1,31 @@
+class Key:
+    """Valid keys in Portkey."""
+    AUTHORIZATION: str
+    BUDGET_TOKENS: str
+    CONFIG: str
+    CONTENT: str
+    CONTENT_BLOCKS: str
+    CUSTOM_HOST: str
+    DELTA: str
+    MAX_RETRIES: str
+    MODEL: str
+    PROVIDER: str
+    PROVIDER_MODEL: str
+    REQUEST_TIMEOUT: str
+    RESPONSE_FORMAT: str
+    STRICT_OPEN_AI_COMPLIANCE: str
+    THINKING: str
+    TOOLS: str
+    TYPE: str
+    USAGE: str
+
+class InputType:
+    """Valid input types in Portkey."""
+    ENABLED: str
+
+class AuthConfig:
+    """Authentication configuration keys."""
+    CONFIG: str
+    MODEL: str
+    PROVIDER_AUTH: str
+    PROVIDER_CUSTOM_HOST: str

gllm_inference/lm_invoker/schema/xai.pyi

@@ -0,0 +1,31 @@
+from enum import StrEnum
+
+class Key:
+    """Defines valid keys in xAI."""
+    ARGUMENTS: str
+    CHANNEL_OPTIONS: str
+    CITATIONS: str
+    COMPLETION_TOKENS: str
+    CONTENT: str
+    FINISH_REASON: str
+    FUNCTION: str
+    ID: str
+    NAME: str
+    ON: str
+    PROMPT_TOKENS: str
+    REASONING_CONTENT: str
+    REASONING_EFFORT: str
+    RESPONSE_FORMAT: str
+    SEARCH_PARAMETERS: str
+    TIMEOUT: str
+    TOOL_CALLS: str
+    TOOLS: str
+    TYPE: str
+    URL: str
+    URL_CITATION: str
+    USAGE: str
+
+class ReasoningEffort(StrEnum):
+    """Defines the reasoning effort for reasoning models."""
+    HIGH = 'high'
+    LOW = 'low'