hammad-python 0.0.19__py3-none-any.whl → 0.0.21__py3-none-any.whl

hammad/genai/{embedding_models/embedding_model_request.py → models/embeddings/types/embedding_model_run_params.py}

@@ -1,6 +1,7 @@
-"""hammad.genai.embedding_models.embedding_model_request"""
+"""hammad.genai.embedding_models.embedding_model_run_params"""
 
 import sys
+
 if sys.version_info >= (3, 12):
     from typing import TypedDict, Required, NotRequired
 else:
@@ -20,11 +21,11 @@ from typing import (
 from .embedding_model_name import EmbeddingModelName
 
 __all__ = [
-    "EmbeddingModelRequest",
+    "EmbeddingModelRunParams",
 ]
 
 
-class EmbeddingModelRequest(TypedDict, total=False):
+class EmbeddingModelRunParams(TypedDict, total=False):
     """A request to an embedding model."""
 
     input: List[Any] | Any

hammad/genai/models/embeddings/types/embedding_model_settings.py

@@ -0,0 +1,47 @@
+"""hammad.genai.models.embeddings.types.embedding_model_settings"""
+
+from pydantic import BaseModel
+from typing import Any, List, Optional
+
+from .embedding_model_name import EmbeddingModelName
+from ....types.base import BaseGenAIModelSettings
+
+
+__all__ = [
+    "EmbeddingModelSettings",
+]
+
+
+class EmbeddingModelSettings(BaseGenAIModelSettings):
+    """A request to an embedding model."""
+
+    format: bool = False
+    """Whether to format each non-string input as a markdown string."""
+
+    # LiteLLM Settings
+    dimensions: Optional[int] = None
+    """The dimensions of the embedding."""
+
+    encoding_format: Optional[str] = None
+    """The encoding format of the embedding."""
+
+    timeout: Optional[int] = None
+    """The timeout for the embedding request."""
+
+    api_base: Optional[str] = None
+    """The API base for the embedding request."""
+
+    api_version: Optional[str] = None
+    """The API version for the embedding request."""
+
+    api_key: Optional[str] = None
+    """The API key for the embedding request."""
+
+    api_type: Optional[str] = None
+    """The API type for the embedding request."""
+
+    caching: bool = False
+    """Whether to cache the embedding request."""
+
+    user: Optional[str] = None
+    """The user for the embedding request."""

hammad/genai/models/language/__init__.py

@@ -0,0 +1,48 @@
+"""hammad.genai.models.language"""
+
+from typing import TYPE_CHECKING
+from ...._internal import create_getattr_importer
+
+
+if TYPE_CHECKING:
+    from .model import LanguageModel
+    from .run import run_language_model, async_run_language_model
+    from .types.language_model_instructor_mode import LanguageModelInstructorMode
+    from .types.language_model_messages import LanguageModelMessages
+    from .types.language_model_name import LanguageModelName
+    from .types.language_model_request import LanguageModelRequest
+    from .types.language_model_response import LanguageModelResponse
+    from .types.language_model_response_chunk import LanguageModelResponseChunk
+    from .types.language_model_settings import LanguageModelSettings
+    from .types.language_model_stream import LanguageModelStream
+
+__all__ = [
+    # hammad.genai.models.language.model
+    "LanguageModel",
+    # hammad.genai.models.language.run
+    "run_language_model",
+    "async_run_language_model",
+    # hammad.genai.models.language.types.language_model_instructor_mode
+    "LanguageModelInstructorMode",
+    # hammad.genai.models.language.types.language_model_messages
+    "LanguageModelMessages",
+    # hammad.genai.models.language.types.language_model_name
+    "LanguageModelName",
+    # hammad.genai.models.language.types.language_model_request
+    "LanguageModelRequest",
+    # hammad.genai.models.language.types.language_model_response
+    "LanguageModelResponse",
+    # hammad.genai.models.language.types.language_model_response_chunk
+    "LanguageModelResponseChunk",
+    # hammad.genai.models.language.types.language_model_settings
+    "LanguageModelSettings",
+    # hammad.genai.models.language.types.language_model_stream
+    "LanguageModelStream",
+]
+
+
+__getattr__ = create_getattr_importer(__all__)
+
+
+def __dir__() -> list[str]:
+    return __all__