langroid 0.58.2__py3-none-any.whl → 0.59.0b1__py3-none-any.whl

langroid/language_models/azure_openai.py-e

@@ -0,0 +1,134 @@
+import logging
+from typing import Callable
+
+from dotenv import load_dotenv
+from httpx import Timeout
+from openai import AsyncAzureOpenAI, AzureOpenAI
+
+from langroid.language_models.openai_gpt import (
+    OpenAIGPT,
+    OpenAIGPTConfig,
+)
+from pydantic import ConfigDict
+
+azureStructuredOutputList = [
+    "2024-08-06",
+    "2024-11-20",
+]
+
+azureStructuredOutputAPIMin = "2024-08-01-preview"
+
+logger = logging.getLogger(__name__)
+
+
+class AzureConfig(OpenAIGPTConfig):
+    """
+    Configuration for Azure OpenAI GPT.
+
+    Attributes:
+        type (str): should be ``azure.``
+        api_version (str): can be set in the ``.env`` file as
+            ``AZURE_OPENAI_API_VERSION.``
+        deployment_name (str|None): can be optionally set in the ``.env`` file as
+            ``AZURE_OPENAI_DEPLOYMENT_NAME`` and should be based the custom name you
+            chose for your deployment when you deployed a model.
+        model_name (str): [DEPRECATED] can be set in the ``.env``
+            file as ``AZURE_OPENAI_MODEL_NAME``
+            and should be based on the model name chosen during setup.
+        chat_model (str): the chat model name to use. Can be set via
+            the env variable ``AZURE_OPENAI_CHAT_MODEL``.
+            Recommended to use this instead of ``model_name``.
+
+    """
+
+    api_key: str = ""  # CAUTION: set this ONLY via env var AZURE_OPENAI_API_KEY
+    type: str = "azure"
+    api_version: str = "2023-05-15"
+    deployment_name: str | None = None
+    model_name: str = ""
+    api_base: str = ""
+
+    # Alternatively, bring your own clients:
+    azure_openai_client_provider: Callable[[], AzureOpenAI] | None = None
+    azure_openai_async_client_provider: Callable[[], AsyncAzureOpenAI] | None = None
+
+    # all of the vars above can be set via env vars,
+    # by upper-casing the name and prefixing with `env_prefix`, e.g.
+    # AZURE_OPENAI_API_VERSION=2023-05-15
+    # This is either done in the .env file, or via an explicit
+    # `export AZURE_OPENAI_API_VERSION=...`
+    model_config = ConfigDict(env_prefix="AZURE_OPENAI_")
+
+    def __init__(self, **kwargs) -> None:  # type: ignore
+        if "model_name" in kwargs and "chat_model" not in kwargs:
+            kwargs["chat_model"] = kwargs["model_name"]
+        super().__init__(**kwargs)
+
+
+class AzureGPT(OpenAIGPT):
+    """
+    Class to access OpenAI LLMs via Azure. These env variables can be obtained from the
+    file `.azure_env`. Azure OpenAI doesn't support ``completion``
+    """
+
+    def __init__(self, config: AzureConfig):
+        # This will auto-populate config values from .env file
+        load_dotenv()
+        super().__init__(config)
+        self.config: AzureConfig = config
+
+        if (
+            self.config.azure_openai_client_provider
+            or self.config.azure_openai_async_client_provider
+        ):
+            if not self.config.azure_openai_client_provider:
+                self.client = None
+                logger.warning(
+                    "Using user-provided Azure OpenAI client, but only async "
+                    "client has been provided. Synchronous calls will fail."
+                )
+            if not self.config.azure_openai_async_client_provider:
+                self.async_client = None
+                logger.warning(
+                    "Using user-provided Azure OpenAI client, but no async "
+                    "client has been provided. Asynchronous calls will fail."
+                )
+
+            if self.config.azure_openai_client_provider:
+                self.client = self.config.azure_openai_client_provider()
+            if self.config.azure_openai_async_client_provider:
+                self.async_client = self.config.azure_openai_async_client_provider()
+                self.async_client.timeout = Timeout(self.config.timeout)
+        else:
+            if self.config.api_key == "":
+                raise ValueError(
+                    """
+                    AZURE_OPENAI_API_KEY not set in .env file,
+                    please set it to your Azure API key."""
+                )
+
+            if self.config.api_base == "":
+                raise ValueError(
+                    """
+                    AZURE_OPENAI_API_BASE not set in .env file,
+                    please set it to your Azure API key."""
+                )
+
+            self.client = AzureOpenAI(
+                api_key=self.config.api_key,
+                azure_endpoint=self.config.api_base,
+                api_version=self.config.api_version,
+                azure_deployment=self.config.deployment_name,
+            )
+            self.async_client = AsyncAzureOpenAI(
+                api_key=self.config.api_key,
+                azure_endpoint=self.config.api_base,
+                api_version=self.config.api_version,
+                azure_deployment=self.config.deployment_name,
+                timeout=Timeout(self.config.timeout),
+            )
+
+        self.supports_json_schema = (
+            self.config.api_version >= azureStructuredOutputAPIMin
+            and self.config.api_version in azureStructuredOutputList
+        )

langroid/language_models/base.py

@@ -17,6 +17,9 @@ from typing import (
     cast,
 )
 
+from pydantic import BaseModel, Field
+from pydantic_settings import BaseSettings
+
 from langroid.cachedb.base import CacheDBConfig
 from langroid.cachedb.redis_cachedb import RedisCacheConfig
 from langroid.language_models.model_info import ModelInfo, get_model_info
@@ -24,7 +27,6 @@ from langroid.parsing.agent_chats import parse_message
 from langroid.parsing.file_attachment import FileAttachment
 from langroid.parsing.parse_json import parse_imperfect_json, top_level_json_field
 from langroid.prompts.dialog import collate_chat_history
-from langroid.pydantic_v1 import BaseModel, BaseSettings, Field
 from langroid.utils.configuration import settings
 from langroid.utils.output.printing import show_if_debug
 
@@ -140,7 +142,7 @@ class LLMFunctionCall(BaseModel):
         return fun_call
 
     def __str__(self) -> str:
-        return "FUNC: " + json.dumps(self.dict(), indent=2)
+        return "FUNC: " + json.dumps(self.model_dump(), indent=2)
 
 
 class LLMFunctionSpec(BaseModel):
@@ -186,7 +188,7 @@ class OpenAIToolCall(BaseModel):
     def __str__(self) -> str:
         if self.function is None:
             return ""
-        return "OAI-TOOL: " + json.dumps(self.function.dict(), indent=2)
+        return "OAI-TOOL: " + json.dumps(self.function.model_dump(), indent=2)
 
 
 class OpenAIToolSpec(BaseModel):
@@ -292,7 +294,7 @@ class LLMMessage(BaseModel):
         Returns:
             dict: dictionary representation of LLM message
         """
-        d = self.dict()
+        d = self.model_dump()
         files: List[FileAttachment] = d.pop("files")
         if len(files) > 0 and self.role == Role.USER:
             # In there are files, then content is an array of