gllm-inference-binary 0.5.33__cp311-cp311-macosx_13_0_x86_64.whl → 0.5.68__cp311-cp311-macosx_13_0_x86_64.whl

gllm_inference/builder/_build_invoker.pyi

@@ -0,0 +1,28 @@
+from _typeshed import Incomplete
+from gllm_inference.em_invoker.em_invoker import BaseEMInvoker as BaseEMInvoker
+from gllm_inference.lm_invoker.lm_invoker import BaseLMInvoker as BaseLMInvoker
+from gllm_inference.schema.model_id import ModelId as ModelId, ModelProvider as ModelProvider, PROVIDERS_OPTIONAL_PATH as PROVIDERS_OPTIONAL_PATH
+
+logger: Incomplete
+
+class Key:
+    """Defines valid keys in the config."""
+    ACCESS_KEY_ID: str
+    API_KEY: str
+    AZURE_DEPLOYMENT: str
+    AZURE_ENDPOINT: str
+    BASE_URL: str
+    CONFIG: str
+    CUSTOM_HOST: str
+    CREDENTIALS_PATH: str
+    MODEL_ID: str
+    MODEL_KWARGS: str
+    MODEL_NAME: str
+    MODEL_CLASS_PATH: str
+    PORTKEY_API_KEY: str
+    PROVIDER: str
+    SECRET_ACCESS_KEY: str
+
+PROVIDERS_REQUIRE_BASE_URL: Incomplete
+MODEL_NAME_KEY_MAP: Incomplete
+DEFAULT_MODEL_NAME_KEY: Incomplete

gllm_inference/builder/build_em_invoker.pyi

@@ -1,34 +1,16 @@
-from _typeshed import Incomplete
-from gllm_inference.em_invoker import AzureOpenAIEMInvoker as AzureOpenAIEMInvoker, BedrockEMInvoker as BedrockEMInvoker, GoogleEMInvoker as GoogleEMInvoker, LangChainEMInvoker as LangChainEMInvoker, OpenAICompatibleEMInvoker as OpenAICompatibleEMInvoker, OpenAIEMInvoker as OpenAIEMInvoker, TwelveLabsEMInvoker as TwelveLabsEMInvoker, VoyageEMInvoker as VoyageEMInvoker
+from gllm_inference.em_invoker import AzureOpenAIEMInvoker as AzureOpenAIEMInvoker, BedrockEMInvoker as BedrockEMInvoker, CohereEMInvoker as CohereEMInvoker, GoogleEMInvoker as GoogleEMInvoker, JinaEMInvoker as JinaEMInvoker, LangChainEMInvoker as LangChainEMInvoker, OpenAICompatibleEMInvoker as OpenAICompatibleEMInvoker, OpenAIEMInvoker as OpenAIEMInvoker, TwelveLabsEMInvoker as TwelveLabsEMInvoker, VoyageEMInvoker as VoyageEMInvoker
 from gllm_inference.em_invoker.em_invoker import BaseEMInvoker as BaseEMInvoker
 from gllm_inference.schema.model_id import ModelId as ModelId, ModelProvider as ModelProvider
 from typing import Any
 
 PROVIDER_TO_EM_INVOKER_MAP: dict[str, type[BaseEMInvoker]]
-logger: Incomplete
-
-class Key:
-    """Defines valid keys in the config."""
-    ACCESS_KEY_ID: str
-    API_KEY: str
-    AZURE_DEPLOYMENT: str
-    AZURE_ENDPOINT: str
-    BASE_URL: str
-    CREDENTIALS_PATH: str
-    MODEL_KWARGS: str
-    MODEL_NAME: str
-    MODEL_CLASS_PATH: str
-    SECRET_ACCESS_KEY: str
 
 def build_em_invoker(model_id: str | ModelId, credentials: str | dict[str, Any] | None = None, config: dict[str, Any] | None = None) -> BaseEMInvoker:
     '''Build an embedding model invoker based on the provided configurations.
 
     Args:
-        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in the following format:
-            1. For `azure-openai` provider: `azure-openai/azure-endpoint:azure-deployment`.
-            2. For `openai-compatible` provider: `openai-compatible/base-url:model-name`.
-            3. For `langchain` provider: `langchain/<package>.<class>:model-name`.
-            4. For other providers: `provider/model-name`.
+        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in a format defined
+            in the following page: https://gdplabs.gitbook.io/sdk/resources/supported-models#embedding-models-ems
         credentials (str | dict[str, Any] | None, optional): The credentials for the language model. Can either be:
             1. An API key.
             2. A path to a credentials JSON file, currently only supported for Google Vertex AI.
@@ -74,6 +56,16 @@ def build_em_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         ```
         Providing credentials through environment variable is not supported for Google Vertex AI.
 
+        # Using Jina
+        ```python
+        em_invoker = build_em_invoker(
+            model_id="jina/jina-embeddings-v2-large",
+            credentials="jina-api-key"
+        )
+        ```
+        The credentials can also be provided through the `JINA_API_KEY` environment variable. For the list of supported
+        models, please refer to the following page: https://jina.ai/models
+
         # Using OpenAI
         ```python
         em_invoker = build_em_invoker(
@@ -83,23 +75,23 @@ def build_em_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         ```
         The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
 
-        # Using Azure OpenAI
+        # Using OpenAI Embeddings API-compatible endpoints (e.g. vLLM)
         ```python
         em_invoker = build_em_invoker(
-            model_id="azure-openai/https://my-resource.openai.azure.com/openai/v1:my-deployment",
-            credentials="azure-api-key"
+            model_id="openai/https://my-vllm-url:8000/v1:my-model-name",
+            credentials="sk-..."
         )
         ```
-        The credentials can also be provided through the `AZURE_OPENAI_API_KEY` environment variable.
+        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
 
-        # Using OpenAI Compatible endpoint (e.g. Text Embeddings Inference)
+        # Using Azure OpenAI
         ```python
         em_invoker = build_em_invoker(
-            model_id="openai-compatible/https://my-text-embeddings-inference-endpoint.com:model-name",
-            credentials="tei-api-key"
+            model_id="azure-openai/https://my-resource.openai.azure.com/openai/v1:my-deployment",
+            credentials="azure-api-key"
         )
         ```
-        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
+        The credentials can also be provided through the `AZURE_OPENAI_API_KEY` environment variable.
 
         # Using TwelveLabs
         ```python
@@ -131,6 +123,7 @@ def build_em_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         variables credentials, please refer to the following page:
         https://python.langchain.com/docs/integrations/text_embedding/
 
+
     Security warning:
         Please provide the EM invoker credentials ONLY to the `credentials` parameter. Do not put any kind of
         credentials in the `config` parameter as the content of the `config` parameter will be logged.

gllm_inference/builder/build_lm_invoker.pyi

@@ -1,37 +1,16 @@
-from _typeshed import Incomplete
-from gllm_inference.lm_invoker import AnthropicLMInvoker as AnthropicLMInvoker, AzureOpenAILMInvoker as AzureOpenAILMInvoker, BedrockLMInvoker as BedrockLMInvoker, DatasaurLMInvoker as DatasaurLMInvoker, GoogleLMInvoker as GoogleLMInvoker, LangChainLMInvoker as LangChainLMInvoker, LiteLLMLMInvoker as LiteLLMLMInvoker, OpenAICompatibleLMInvoker as OpenAICompatibleLMInvoker, OpenAILMInvoker as OpenAILMInvoker, XAILMInvoker as XAILMInvoker
+from gllm_inference.lm_invoker import AnthropicLMInvoker as AnthropicLMInvoker, AzureOpenAILMInvoker as AzureOpenAILMInvoker, BedrockLMInvoker as BedrockLMInvoker, DatasaurLMInvoker as DatasaurLMInvoker, GoogleLMInvoker as GoogleLMInvoker, LangChainLMInvoker as LangChainLMInvoker, LiteLLMLMInvoker as LiteLLMLMInvoker, OpenAIChatCompletionsLMInvoker as OpenAIChatCompletionsLMInvoker, OpenAICompatibleLMInvoker as OpenAICompatibleLMInvoker, OpenAILMInvoker as OpenAILMInvoker, PortkeyLMInvoker as PortkeyLMInvoker, SeaLionLMInvoker as SeaLionLMInvoker, XAILMInvoker as XAILMInvoker
 from gllm_inference.lm_invoker.lm_invoker import BaseLMInvoker as BaseLMInvoker
 from gllm_inference.schema.model_id import ModelId as ModelId, ModelProvider as ModelProvider
 from typing import Any
 
 PROVIDER_TO_LM_INVOKER_MAP: dict[str, type[BaseLMInvoker]]
-logger: Incomplete
-
-class Key:
-    """Defines valid keys in the config."""
-    ACCESS_KEY_ID: str
-    API_KEY: str
-    AZURE_DEPLOYMENT: str
-    AZURE_ENDPOINT: str
-    BASE_URL: str
-    CREDENTIALS_PATH: str
-    MODEL_ID: str
-    MODEL_KWARGS: str
-    MODEL_NAME: str
-    MODEL_CLASS_PATH: str
-    SECRET_ACCESS_KEY: str
 
 def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any] | None = None, config: dict[str, Any] | None = None) -> BaseLMInvoker:
     '''Build a language model invoker based on the provided configurations.
 
     Args:
-        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in the following format:
-            1. For `azure-openai` provider: `azure-openai/azure-endpoint:azure-deployment`.
-            2. For `openai-compatible` provider: `openai-compatible/base-url:model-name`.
-            3. For `langchain` provider: `langchain/<package>.<class>:model-name`.
-            4. For `litellm` provider: `litellm/provider/model-name`.
-            5. For `datasaur` provider: `datasaur/deployment-id:model-name`.
-            6. For other providers: `provider/model-name`.
+        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in a format defined
+            in the following page: https://gdplabs.gitbook.io/sdk/resources/supported-models#language-models-lms
         credentials (str | dict[str, Any] | None, optional): The credentials for the language model. Can either be:
             1. An API key.
             2. A path to a credentials JSON file, currently only supported for Google Vertex AI.
@@ -80,7 +59,7 @@ def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         # Using Google Gen AI (via API key)
         ```python
         lm_invoker = build_lm_invoker(
-            model_id="google/gemini-1.5-flash-latest",
+            model_id="google/gemini-2.5-flash-lite",
             credentials="AIzaSyD..."
         )
         ```
@@ -89,7 +68,7 @@ def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         # Using Google Vertex AI (via service account)
         ```python
         lm_invoker = build_lm_invoker(
-            model_id="google/gemini-1.5-flash",
+            model_id="google/gemini-2.5-flash-lite",
             credentials="/path/to/google-credentials.json"
         )
         ```
@@ -98,12 +77,39 @@ def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         # Using OpenAI
         ```python
         lm_invoker = build_lm_invoker(
-            model_id="openai/gpt-4o-mini",
+            model_id="openai/gpt-5-nano",
             credentials="sk-..."
         )
         ```
         The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
 
+        # Using OpenAI with Chat Completions API
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="openai-chat-completions/gpt-5-nano",
+            credentials="sk-..."
+        )
+        ```
+        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
+
+        # Using OpenAI Responses API-compatible endpoints (e.g. SGLang)
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="openai/https://my-sglang-url:8000/v1:my-model-name",
+            credentials="sk-..."
+        )
+        ```
+        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
+
+        # Using OpenAI Chat Completions API-compatible endpoints (e.g. Groq)
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="openai-chat-completions/https://api.groq.com/openai/v1:llama3-8b-8192",
+            credentials="gsk_..."
+        )
+        ```
+        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
+
         # Using Azure OpenAI
         ```python
         lm_invoker = build_lm_invoker(
@@ -113,14 +119,14 @@ def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         ```
         The credentials can also be provided through the `AZURE_OPENAI_API_KEY` environment variable.
 
-        # Using OpenAI Compatible endpoint (e.g. Groq)
+        # Using SEA-LION
         ```python
         lm_invoker = build_lm_invoker(
-            model_id="openai-compatible/https://api.groq.com/openai/v1:llama3-8b-8192",
-            credentials="gsk_..."
+            model_id="sea-lion/aisingapore/Qwen-SEA-LION-v4-32B-IT",
+            credentials="sk-..."
         )
         ```
-        The credentials can also be provided through the `OPENAI_API_KEY` environment variable.
+        The credentials can also be provided through the `SEA_LION_API_KEY` environment variable.
 
         # Using LangChain
         ```python
@@ -144,6 +150,61 @@ def build_lm_invoker(model_id: str | ModelId, credentials: str | dict[str, Any]
         For the list of supported providers, please refer to the following page:
         https://docs.litellm.ai/docs/providers/
 
+        # Using Portkey
+        Portkey supports multiple authentication methods with strict precedence order.
+        Authentication methods are mutually exclusive and cannot be combined.
+
+        ## Config ID Authentication (Highest Precedence)
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="portkey/any-model",
+            credentials="portkey-api-key",
+            config={"config": "pc-openai-4f6905"}
+        )
+        ```
+
+        ## Model Catalog Authentication (Combined Format)
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="portkey/@openai-custom/gpt-4o",
+            credentials="portkey-api-key"
+        )
+        ```
+
+        ## Model Catalog Authentication (Separate Parameters)
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="portkey/gpt-4o",
+            credentials="portkey-api-key",
+            config={"provider": "@openai-custom"}
+        )
+        ```
+
+        ## Direct Provider Authentication
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="portkey/gpt-4o",
+            credentials={
+                "portkey_api_key": "portkey-api-key",
+                "api_key": "sk-...",  # Provider\'s API key
+                "provider": "openai"  # Direct provider (no \'@\' prefix)
+            }
+        )
+        ```
+
+        ## Custom Host Override
+        ```python
+        lm_invoker = build_lm_invoker(
+            model_id="portkey/@custom-provider/gpt-4o",
+            credentials="portkey-api-key",
+            config={"custom_host": "https://your-custom-endpoint.com"}
+        )
+        ```
+
+        The Portkey API key can also be provided through the `PORTKEY_API_KEY` environment variable.
+        For more details on authentication methods, please refer to:
+        https://portkey.ai/docs/product/ai-gateway/universal-api
+
         # Using xAI
         ```python
         lm_invoker = build_lm_invoker(

gllm_inference/builder/build_lm_request_processor.pyi

@@ -12,13 +12,8 @@ def build_lm_request_processor(model_id: str | ModelId, credentials: str | dict[
     '''Build a language model invoker based on the provided configurations.
 
     Args:
-        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in the following format:
-            1. For `azure-openai` provider: `azure-openai/azure-endpoint:azure-deployment`.
-            2. For `openai-compatible` provider: `openai-compatible/base-url:model-name`.
-            3. For `langchain` provider: `langchain/<package>.<class>:model-name`.
-            4. For `litellm` provider: `litellm/provider/model-name`.
-            5. For `datasaur` provider: `datasaur/base-url`.
-            6. For other providers: `provider/model-name`.
+        model_id (str | ModelId): The model id, can either be a ModelId instance or a string in a format defined
+            in the following page: https://gdplabs.gitbook.io/sdk/resources/supported-models#language-models-lms
         credentials (str | dict[str, Any] | None, optional): The credentials for the language model. Can either be:
             1. An API key.
             2. A path to a credentials JSON file, currently only supported for Google Vertex AI.

gllm_inference/catalog/lm_request_processor_catalog.pyi

@@ -57,7 +57,7 @@ class LMRequestProcessorCatalog(BaseCatalog[LMRequestProcessor]):
                 ),
                 "user_template": "{query}",
                 "key_defaults": \'{"context": "<default context>"}\',
-                "model_id": "openai/gpt-4.1-nano",
+                "model_id": "openai/gpt-5-nano",
                 "credentials": "OPENAI_API_KEY",
                 "config": "",
                 "output_parser_type": "none",
@@ -93,7 +93,7 @@ class LMRequestProcessorCatalog(BaseCatalog[LMRequestProcessor]):
             prompt template keys. These default values will be applied when the corresponding keys are not provided
             in the runtime input. If it is empty, the prompt template keys will not have default values.
         3. The `model_id`:
-            3.1. Must be filled with the model ID of the LM invoker, e.g. "openai/gpt-4.1-nano".
+            3.1. Must be filled with the model ID of the LM invoker, e.g. "openai/gpt-5-nano".
             3.2. Can be partially loaded from the environment variable using the "${ENV_VAR_KEY}" syntax,
                 e.g. "azure-openai/${AZURE_ENDPOINT}/${AZURE_DEPLOYMENT}".
             3.3. For the available model ID formats, see: https://gdplabs.gitbook.io/sdk/resources/supported-models

gllm_inference/constants.pyi

@@ -2,9 +2,11 @@ from _typeshed import Incomplete
 
 AZURE_OPENAI_URL_SUFFIX: str
 DOCUMENT_MIME_TYPES: Incomplete
+EMBEDDING_ENDPOINT: str
 GOOGLE_SCOPES: Incomplete
 GRPC_ENABLE_RETRIES_KEY: str
-INVOKER_PROPAGATED_MAX_RETRIES: int
 INVOKER_DEFAULT_TIMEOUT: float
-HEX_REPR_LENGTH: int
+INVOKER_PROPAGATED_MAX_RETRIES: int
+JINA_DEFAULT_URL: str
+OPENAI_DEFAULT_URL: str
 SECONDS_TO_MILLISECONDS: int

gllm_inference/em_invoker/__init__.pyi

@@ -1,10 +1,12 @@
 from gllm_inference.em_invoker.azure_openai_em_invoker import AzureOpenAIEMInvoker as AzureOpenAIEMInvoker
 from gllm_inference.em_invoker.bedrock_em_invoker import BedrockEMInvoker as BedrockEMInvoker
+from gllm_inference.em_invoker.cohere_em_invoker import CohereEMInvoker as CohereEMInvoker
 from gllm_inference.em_invoker.google_em_invoker import GoogleEMInvoker as GoogleEMInvoker
+from gllm_inference.em_invoker.jina_em_invoker import JinaEMInvoker as JinaEMInvoker
 from gllm_inference.em_invoker.langchain_em_invoker import LangChainEMInvoker as LangChainEMInvoker
 from gllm_inference.em_invoker.openai_compatible_em_invoker import OpenAICompatibleEMInvoker as OpenAICompatibleEMInvoker
 from gllm_inference.em_invoker.openai_em_invoker import OpenAIEMInvoker as OpenAIEMInvoker
 from gllm_inference.em_invoker.twelevelabs_em_invoker import TwelveLabsEMInvoker as TwelveLabsEMInvoker
 from gllm_inference.em_invoker.voyage_em_invoker import VoyageEMInvoker as VoyageEMInvoker
 
-__all__ = ['AzureOpenAIEMInvoker', 'BedrockEMInvoker', 'GoogleEMInvoker', 'LangChainEMInvoker', 'OpenAIEMInvoker', 'OpenAICompatibleEMInvoker', 'TwelveLabsEMInvoker', 'VoyageEMInvoker']
+__all__ = ['AzureOpenAIEMInvoker', 'BedrockEMInvoker', 'CohereEMInvoker', 'GoogleEMInvoker', 'JinaEMInvoker', 'LangChainEMInvoker', 'OpenAIEMInvoker', 'OpenAICompatibleEMInvoker', 'TwelveLabsEMInvoker', 'VoyageEMInvoker']

gllm_inference/em_invoker/azure_openai_em_invoker.pyi

@@ -13,7 +13,7 @@ class AzureOpenAIEMInvoker(OpenAIEMInvoker):
         model_id (str): The model ID of the embedding model.
         model_provider (str): The provider of the embedding model.
         model_name (str): The name of the Azure OpenAI embedding model deployment.
-        client (AsyncAzureOpenAI): The client for the Azure OpenAI API.
+        client_kwargs (dict[str, Any]): The keyword arguments for the Azure OpenAI client.
         default_hyperparameters (dict[str, Any]): Default hyperparameters for invoking the embedding model.
         retry_config (RetryConfig): The retry configuration for the embedding model.
         truncation_config (TruncationConfig | None): The truncation configuration for the embedding model.
@@ -57,9 +57,9 @@ class AzureOpenAIEMInvoker(OpenAIEMInvoker):
 
         Retry config examples:
         ```python
-        retry_config = RetryConfig(max_retries=0, timeout=0.0)  # No retry, no timeout
+        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=0.0)  # 5 max retries, no 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
         ```
 
@@ -68,7 +68,7 @@ class AzureOpenAIEMInvoker(OpenAIEMInvoker):
         em_invoker = AzureOpenAIEMInvoker(..., retry_config=retry_config)
         ```
     '''
-    client: Incomplete
+    client_kwargs: Incomplete
     def __init__(self, azure_endpoint: str, azure_deployment: str, api_key: str | None = None, api_version: str | None = None, model_kwargs: dict[str, Any] | None = None, default_hyperparameters: dict[str, Any] | None = None, retry_config: RetryConfig | None = None, truncation_config: TruncationConfig | None = None) -> None:
         """Initializes a new instance of the AzureOpenAIEMInvoker class.
 

gllm_inference/em_invoker/bedrock_em_invoker.pyi

@@ -5,12 +5,13 @@ from gllm_inference.em_invoker.em_invoker import BaseEMInvoker as BaseEMInvoker
 from gllm_inference.em_invoker.schema.bedrock import InputType as InputType, Key as Key, OutputType as OutputType
 from gllm_inference.exceptions import BaseInvokerError as BaseInvokerError, convert_http_status_to_base_invoker_error as convert_http_status_to_base_invoker_error
 from gllm_inference.exceptions.provider_error_map import BEDROCK_ERROR_MAPPING as BEDROCK_ERROR_MAPPING
-from gllm_inference.schema import ModelId as ModelId, ModelProvider as ModelProvider, TruncationConfig as TruncationConfig, Vector as Vector
+from gllm_inference.schema import Attachment as Attachment, AttachmentType as AttachmentType, EMContent as EMContent, ModelId as ModelId, ModelProvider as ModelProvider, TruncationConfig as TruncationConfig, Vector as Vector
 from typing import Any
 
 class ModelType(StrEnum):
     """Defines the type of the Bedrock embedding model."""
     COHERE = 'cohere'
+    MARENGO = 'marengo'
     TITAN = 'titan'
 
 SUPPORTED_ATTACHMENTS: Incomplete
@@ -29,12 +30,14 @@ class BedrockEMInvoker(BaseEMInvoker):
         truncation_config (TruncationConfig | None): The truncation configuration for the embedding model.
 
     Input types:
-        The `BedrockEMInvoker` only supports text inputs.
+        The `BedrockEMInvoker` supports:
+        1. Text inputs for Cohere, Titan, and Marengo models
+        2. Image inputs for Marengo models through Attachment objects
 
     Output format:
         The `BedrockEMInvoker` can embed either:
         1. A single content.
-           1. A single content is a single text.
+           1. A single content is a single text or single image (image only supported for Marengo).
            2. The output will be a `Vector`, representing the embedding of the content.
 
            # Example 1: Embedding a text content.
@@ -43,10 +46,19 @@ class BedrockEMInvoker(BaseEMInvoker):
            result = await em_invoker.invoke(text)
            ```
 
+           # Example 2: Embedding an image with Marengo.
+           ```python
+           em_invoker = BedrockEMInvoker(
+               model_name="us.twelvelabs.marengo-2.7"
+           )
+           image = Attachment.from_path("path/to/local/image.png")
+           result = await em_invoker.invoke(image)
+           ```
+
            The above examples will return a `Vector` with a size of (embedding_size,).
 
         2. A list of contents.
-           1. A list of contents is a list of texts.
+           1. A list of contents is a list of texts or images (images only supported for Marengo).
            2. The output will be a `list[Vector]`, where each element is a `Vector` representing the
               embedding of each single content.
 
@@ -67,9 +79,9 @@ class BedrockEMInvoker(BaseEMInvoker):
 
         Retry config examples:
         ```python
-        retry_config = RetryConfig(max_retries=0, timeout=0.0)  # No retry, no timeout
+        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=0.0)  # 5 max retries, no 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
         ```
 

gllm_inference/em_invoker/cohere_em_invoker.pyi

@@ -0,0 +1,127 @@
+from _typeshed import Incomplete
+from gllm_core.utils import RetryConfig as RetryConfig
+from gllm_inference.em_invoker.em_invoker import BaseEMInvoker as BaseEMInvoker
+from gllm_inference.em_invoker.schema.cohere import CohereInputType as CohereInputType, Key as Key
+from gllm_inference.schema import Attachment as Attachment, AttachmentType as AttachmentType, EMContent as EMContent, ModelId as ModelId, ModelProvider as ModelProvider, TruncationConfig as TruncationConfig, Vector as Vector
+from typing import Any
+
+SUPPORTED_ATTACHMENTS: Incomplete
+MULTIMODAL_MODEL_VERSION: Incomplete
+
+class CohereEMInvoker(BaseEMInvoker):
+    '''An embedding model invoker to interact with Cohere embedding models.
+
+    Attributes:
+        model_id (str): The model ID of the embedding model.
+        model_provider (str): The provider of the embedding model (Cohere).
+        model_name (str): The name of the Cohere embedding model.
+        client (AsyncClient): The asynchronous client for the Cohere API.
+        default_hyperparameters (dict[str, Any]): Default hyperparameters for invoking the embedding model.
+        retry_config (RetryConfig): The retry configuration for the embedding model.
+        truncation_config (TruncationConfig | None): The truncation configuration for the embedding model.
+        input_type (CohereInputType): The input type for the embedding model. Supported values include:
+            1. `CohereInputType.SEARCH_DOCUMENT`,
+            2. `CohereInputType.SEARCH_QUERY`,
+            3. `CohereInputType.CLASSIFICATION`,
+            4. `CohereInputType.CLUSTERING`,
+            5. `CohereInputType.IMAGE`.
+
+    Initialization:
+        You can initialize the `CohereEMInvoker` as follows:
+        ```python
+        em_invoker = CohereEMInvoker(
+            model_name="embed-english-v4.0",
+            input_type="search_document"
+        )
+        ```
+
+        Note: The `input_type` parameter can be one of the following:
+        1. "search_document"
+        2. "search_query"
+        3. "classification"
+        4. "clustering"
+        5. "image"
+
+        This parameter is optional and defaults to "search_document". For more information about
+        input_type, please refer to https://docs.cohere.com/docs/embeddings#the-input_type-parameter.
+
+    Input types:
+        The `CohereEMInvoker` supports the following input types: text and image.
+        Non-text inputs must be passed as an `Attachment` object.
+
+    Output format:
+        The `CohereEMInvoker` can embed either:
+        1. A single content.
+           1. A single content is either a text or an image.
+           2. The output will be a `Vector`, representing the embedding of the content.
+
+           # Example 1: Embedding a text content.
+           ```python
+           text = "What animal is in this image?"
+           result = await em_invoker.invoke(text)
+           ```
+
+           # Example 2: Embedding an image content.
+           ```python
+           image = Attachment.from_path("path/to/local/image.png")
+           result = await em_invoker.invoke(image)
+           ```
+
+           The above examples will return a `Vector` with a size of (embedding_size,).
+
+        2. A list of contents.
+           1. A list of contents is a list that consists of any of the above single contents.
+           2. The output will be a `list[Vector]`, where each element is a `Vector` representing the
+              embedding of each single content.
+
+           # Example: Embedding a list of contents.
+           ```python
+           text = "What animal is in this image?"
+           image = Attachment.from_path("path/to/local/image.png")
+           result = await em_invoker.invoke([text, image])
+           ```
+
+           The above examples will return a `list[Vector]` with a size of (2, embedding_size).
+
+    Retry and timeout:
+        The `CohereEMInvoker` 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
+        em_invoker = CohereEMInvoker(..., retry_config=retry_config)
+        ```
+
+    '''
+    input_type: Incomplete
+    client: Incomplete
+    def __init__(self, model_name: str, api_key: str | None = None, base_url: str | None = None, model_kwargs: dict[str, Any] | None = None, default_hyperparameters: dict[str, Any] | None = None, retry_config: RetryConfig | None = None, truncation_config: TruncationConfig | None = None, input_type: CohereInputType = ...) -> None:
+        '''Initializes a new instance of the CohereEMInvoker class.
+
+        Args:
+            model_name (str): The name of the Cohere embedding model to be used.
+            api_key (str | None, optional): The API key for authenticating with Cohere. Defaults to None, in which
+                case the `COHERE_API_KEY` environment variable will be used.
+            base_url (str | None, optional): The base URL for a custom Cohere-compatible endpoint.
+                Defaults to None, in which case Cohere\'s default URL will be used.
+            model_kwargs (dict[str, Any] | None, optional): Additional keyword arguments for the Cohere client.
+                Defaults to None.
+            default_hyperparameters (dict[str, Any] | None, optional): Default hyperparameters for invoking the model.
+                Defaults to None.
+            retry_config (RetryConfig | None, optional): The retry configuration for the embedding model.
+                Defaults to None, in which case a default config with no retry and 30.0 seconds timeout will be used.
+            truncation_config (TruncationConfig | None, optional): Configuration for text truncation behavior.
+                Defaults to None, in which case no truncation is applied.
+            input_type (CohereInputType, optional): The input type for the embedding model.
+                Defaults to `CohereInputType.SEARCH_DOCUMENT`. Valid values are: "search_document", "search_query",
+                "classification", "clustering", and "image".
+        '''

gllm_inference/em_invoker/google_em_invoker.pyi

@@ -89,9 +89,9 @@ class GoogleEMInvoker(BaseEMInvoker):
 
         Retry config examples:
         ```python
-        retry_config = RetryConfig(max_retries=0, timeout=0.0)  # No retry, no timeout
+        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=0.0)  # 5 max retries, no 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
         ```