semantic-kernel 1.8.3__zip

semantic_kernel-1.8.3/semantic_kernel/connectors/ai/open_ai/services/azure_text_completion.py

@@ -0,0 +1,107 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import logging
+from collections.abc import Mapping
+from typing import Any
+
+from openai import AsyncAzureOpenAI
+from openai.lib.azure import AsyncAzureADTokenProvider
+from pydantic import ValidationError
+
+from semantic_kernel.connectors.ai.open_ai.services.azure_config_base import AzureOpenAIConfigBase
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_handler import OpenAIModelTypes
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_completion_base import OpenAITextCompletionBase
+from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
+from semantic_kernel.exceptions.service_exceptions import ServiceInitializationError
+
+logger: logging.Logger = logging.getLogger(__name__)
+
+
+class AzureTextCompletion(AzureOpenAIConfigBase, OpenAITextCompletionBase):
+    """Azure Text Completion class."""
+
+    def __init__(
+        self,
+        service_id: str | None = None,
+        api_key: str | None = None,
+        deployment_name: str | None = None,
+        endpoint: str | None = None,
+        base_url: str | None = None,
+        api_version: str | None = None,
+        ad_token: str | None = None,
+        ad_token_provider: AsyncAzureADTokenProvider | None = None,
+        default_headers: Mapping[str, str] | None = None,
+        async_client: AsyncAzureOpenAI | None = None,
+        env_file_path: str | None = None,
+    ) -> None:
+        """Initialize an AzureTextCompletion service.
+
+        Args:
+            service_id: The service ID for the Azure deployment. (Optional)
+            api_key (str | None): The optional api key. If provided, will override the value in the
+                env vars or .env file.
+            deployment_name  (str | None): The optional deployment. If provided, will override the value
+                (text_deployment_name) in the env vars or .env file.
+            endpoint (str | None): The optional deployment endpoint. If provided will override the value
+                in the env vars or .env file.
+            base_url (str | None): The optional deployment base_url. If provided will override the value
+                in the env vars or .env file.
+            api_version (str | None): The optional deployment api version. If provided will override the value
+                in the env vars or .env file.
+            ad_token: The Azure Active Directory token. (Optional)
+            ad_token_provider: The Azure Active Directory token provider. (Optional)
+            default_headers: The default headers mapping of string keys to
+                string values for HTTP requests. (Optional)
+            async_client (Optional[AsyncAzureOpenAI]): An existing client to use. (Optional)
+            env_file_path (str | None): Use the environment settings file as a fallback to
+                environment variables. (Optional)
+        """
+        try:
+            azure_openai_settings = AzureOpenAISettings.create(
+                env_file_path=env_file_path,
+                text_deployment_name=deployment_name,
+                endpoint=endpoint,
+                base_url=base_url,
+                api_key=api_key,
+                api_version=api_version,
+            )
+        except ValidationError as ex:
+            raise ServiceInitializationError(f"Invalid settings: {ex}") from ex
+        if not azure_openai_settings.text_deployment_name:
+            raise ServiceInitializationError("The Azure Text deployment name is required.")
+
+        super().__init__(
+            deployment_name=azure_openai_settings.text_deployment_name,
+            endpoint=azure_openai_settings.endpoint,
+            base_url=azure_openai_settings.base_url,
+            api_version=azure_openai_settings.api_version,
+            service_id=service_id,
+            api_key=azure_openai_settings.api_key.get_secret_value() if azure_openai_settings.api_key else None,
+            ad_token=ad_token,
+            ad_token_provider=ad_token_provider,
+            default_headers=default_headers,
+            ai_model_type=OpenAIModelTypes.TEXT,
+            client=async_client,
+        )
+
+    @classmethod
+    def from_dict(cls, settings: dict[str, Any]) -> "AzureTextCompletion":
+        """Initialize an Azure OpenAI service from a dictionary of settings.
+
+        Args:
+            settings: A dictionary of settings for the service.
+                should contain keys: deployment_name, endpoint, api_key
+                and optionally: api_version, ad_auth
+        """
+        return AzureTextCompletion(
+            service_id=settings.get("service_id"),
+            api_key=settings.get("api_key"),
+            deployment_name=settings.get("deployment_name"),
+            endpoint=settings.get("endpoint"),
+            base_url=settings.get("base_url"),
+            api_version=settings.get("api_version"),
+            ad_token=settings.get("ad_token"),
+            ad_token_provider=settings.get("ad_token_provider"),
+            default_headers=settings.get("default_headers"),
+            env_file_path=settings.get("env_file_path"),
+        )

semantic_kernel-1.8.3/semantic_kernel/connectors/ai/open_ai/services/azure_text_embedding.py

@@ -0,0 +1,109 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import logging
+from collections.abc import Mapping
+from typing import Any
+
+from openai import AsyncAzureOpenAI
+from openai.lib.azure import AsyncAzureADTokenProvider
+from pydantic import ValidationError
+
+from semantic_kernel.connectors.ai.open_ai.services.azure_config_base import AzureOpenAIConfigBase
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_handler import OpenAIModelTypes
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding_base import OpenAITextEmbeddingBase
+from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
+from semantic_kernel.exceptions.service_exceptions import ServiceInitializationError
+from semantic_kernel.utils.experimental_decorator import experimental_class
+
+logger: logging.Logger = logging.getLogger(__name__)
+
+
+@experimental_class
+class AzureTextEmbedding(AzureOpenAIConfigBase, OpenAITextEmbeddingBase):
+    """Azure Text Embedding class."""
+
+    def __init__(
+        self,
+        service_id: str | None = None,
+        api_key: str | None = None,
+        deployment_name: str | None = None,
+        endpoint: str | None = None,
+        base_url: str | None = None,
+        api_version: str | None = None,
+        ad_token: str | None = None,
+        ad_token_provider: AsyncAzureADTokenProvider | None = None,
+        default_headers: Mapping[str, str] | None = None,
+        async_client: AsyncAzureOpenAI | None = None,
+        env_file_path: str | None = None,
+    ) -> None:
+        """Initialize an AzureTextEmbedding service.
+
+        service_id: The service ID. (Optional)
+        api_key  {str | None}: The optional api key. If provided, will override the value in the
+                env vars or .env file.
+        deployment_name  {str | None}: The optional deployment. If provided, will override the value
+            (text_deployment_name) in the env vars or .env file.
+        endpoint {str | None}: The optional deployment endpoint. If provided will override the value
+            in the env vars or .env file.
+        base_url {str | None}: The optional deployment base_url. If provided will override the value
+            in the env vars or .env file.
+        api_version {str | None}: The optional deployment api version. If provided will override the value
+            in the env vars or .env file.
+        ad_token {str | None}: The Azure AD token for authentication. (Optional)
+        ad_auth {AsyncAzureADTokenProvider | None}: Whether to use Azure Active Directory authentication.
+            (Optional) The default value is False.
+        default_headers: The default headers mapping of string keys to
+                string values for HTTP requests. (Optional)
+        async_client (Optional[AsyncAzureOpenAI]): An existing client to use. (Optional)
+        env_file_path (str | None): Use the environment settings file as a fallback to
+            environment variables. (Optional)
+        """
+        try:
+            azure_openai_settings = AzureOpenAISettings.create(
+                env_file_path=env_file_path,
+                api_key=api_key,
+                embedding_deployment_name=deployment_name,
+                endpoint=endpoint,
+                base_url=base_url,
+                api_version=api_version,
+            )
+        except ValidationError as exc:
+            raise ServiceInitializationError(f"Invalid settings: {exc}") from exc
+        if not azure_openai_settings.embedding_deployment_name:
+            raise ServiceInitializationError("The Azure OpenAI embedding deployment name is required.")
+
+        super().__init__(
+            deployment_name=azure_openai_settings.embedding_deployment_name,
+            endpoint=azure_openai_settings.endpoint,
+            base_url=azure_openai_settings.base_url,
+            api_version=azure_openai_settings.api_version,
+            service_id=service_id,
+            api_key=azure_openai_settings.api_key.get_secret_value() if azure_openai_settings.api_key else None,
+            ad_token=ad_token,
+            ad_token_provider=ad_token_provider,
+            default_headers=default_headers,
+            ai_model_type=OpenAIModelTypes.EMBEDDING,
+            client=async_client,
+        )
+
+    @classmethod
+    def from_dict(cls, settings: dict[str, Any]) -> "AzureTextEmbedding":
+        """Initialize an Azure OpenAI service from a dictionary of settings.
+
+        Args:
+            settings: A dictionary of settings for the service.
+                should contain keys: deployment_name, endpoint, api_key
+                and optionally: api_version, ad_auth
+        """
+        return AzureTextEmbedding(
+            service_id=settings.get("service_id"),
+            api_key=settings.get("api_key"),
+            deployment_name=settings.get("deployment_name"),
+            endpoint=settings.get("endpoint"),
+            base_url=settings.get("base_url"),
+            api_version=settings.get("api_version"),
+            ad_token=settings.get("ad_token"),
+            ad_token_provider=settings.get("ad_token_provider"),
+            default_headers=settings.get("default_headers"),
+            env_file_path=settings.get("env_file_path"),
+        )

semantic_kernel-1.8.3/semantic_kernel/connectors/ai/open_ai/services/azure_text_to_image.py

@@ -0,0 +1,111 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from openai import AsyncAzureOpenAI
+from openai.lib.azure import AsyncAzureADTokenProvider
+from pydantic import ValidationError
+
+from semantic_kernel.connectors.ai.open_ai.services.azure_config_base import AzureOpenAIConfigBase
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_model_types import OpenAIModelTypes
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_to_image_base import OpenAITextToImageBase
+from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
+from semantic_kernel.exceptions.service_exceptions import ServiceInitializationError
+
+T_ = TypeVar("T_", bound="AzureTextToImage")
+
+
+class AzureTextToImage(AzureOpenAIConfigBase, OpenAITextToImageBase):
+    """Azure Text to Image service."""
+
+    def __init__(
+        self,
+        service_id: str | None = None,
+        api_key: str | None = None,
+        deployment_name: str | None = None,
+        endpoint: str | None = None,
+        base_url: str | None = None,
+        api_version: str | None = None,
+        ad_token: str | None = None,
+        ad_token_provider: AsyncAzureADTokenProvider | None = None,
+        default_headers: Mapping[str, str] | None = None,
+        async_client: AsyncAzureOpenAI | None = None,
+        env_file_path: str | None = None,
+        env_file_encoding: str | None = None,
+    ) -> None:
+        """Initialize an AzureTextToImage service.
+
+        Args:
+            service_id: The service ID. (Optional)
+            api_key: The optional api key. If provided, will override the value in the
+                    env vars or .env file.
+            deployment_name: The optional deployment. If provided, will override the value
+                (text_to_image_deployment_name) in the env vars or .env file.
+            endpoint: The optional deployment endpoint. If provided will override the value
+                in the env vars or .env file.
+            base_url: The optional deployment base_url. If provided will override the value
+                in the env vars or .env file.
+            api_version: The optional deployment api version. If provided will override the value
+                in the env vars or .env file.
+            ad_token: The Azure AD token for authentication. (Optional)
+            ad_token_provider: Azure AD Token provider. (Optional)
+            ad_auth: Whether to use Azure Active Directory authentication.
+                (Optional) The default value is False.
+            default_headers: The default headers mapping of string keys to
+                    string values for HTTP requests. (Optional)
+            async_client: An existing client to use. (Optional)
+            env_file_path: Use the environment settings file as a fallback to
+                environment variables. (Optional)
+            env_file_encoding: The encoding of the environment settings file. (Optional)
+        """
+        try:
+            azure_openai_settings = AzureOpenAISettings.create(
+                env_file_path=env_file_path,
+                env_file_encoding=env_file_encoding,
+                api_key=api_key,
+                text_to_image_deployment_name=deployment_name,
+                endpoint=endpoint,
+                base_url=base_url,
+                api_version=api_version,
+            )
+        except ValidationError as exc:
+            raise ServiceInitializationError(f"Invalid settings: {exc}") from exc
+        if not azure_openai_settings.text_to_image_deployment_name:
+            raise ServiceInitializationError("The Azure OpenAI text to image deployment name is required.")
+
+        super().__init__(
+            deployment_name=azure_openai_settings.text_to_image_deployment_name,
+            endpoint=azure_openai_settings.endpoint,
+            base_url=azure_openai_settings.base_url,
+            api_version=azure_openai_settings.api_version,
+            service_id=service_id,
+            api_key=azure_openai_settings.api_key.get_secret_value() if azure_openai_settings.api_key else None,
+            ad_token=ad_token,
+            ad_token_provider=ad_token_provider,
+            default_headers=default_headers,
+            ai_model_type=OpenAIModelTypes.IMAGE,
+            client=async_client,
+        )
+
+    @classmethod
+    def from_dict(cls: type[T_], settings: dict[str, Any]) -> T_:
+        """Initialize an Azure OpenAI service from a dictionary of settings.
+
+        Args:
+            settings: A dictionary of settings for the service.
+                should contain keys: deployment_name, endpoint, api_key
+                and optionally: api_version, ad_auth
+        """
+        return cls(
+            service_id=settings.get("service_id"),
+            api_key=settings.get("api_key"),
+            deployment_name=settings.get("deployment_name"),
+            endpoint=settings.get("endpoint"),
+            base_url=settings.get("base_url"),
+            api_version=settings.get("api_version"),
+            ad_token=settings.get("ad_token"),
+            ad_token_provider=settings.get("ad_token_provider"),
+            default_headers=settings.get("default_headers"),
+            env_file_path=settings.get("env_file_path"),
+        )

semantic_kernel-1.8.3/semantic_kernel/connectors/ai/open_ai/services/open_ai_chat_completion.py

@@ -0,0 +1,88 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import logging
+from collections.abc import Mapping
+from typing import Any
+
+from openai import AsyncOpenAI
+from pydantic import ValidationError
+
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion_base import OpenAIChatCompletionBase
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_config_base import OpenAIConfigBase
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_handler import OpenAIModelTypes
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_completion_base import OpenAITextCompletionBase
+from semantic_kernel.connectors.ai.open_ai.settings.open_ai_settings import OpenAISettings
+from semantic_kernel.exceptions.service_exceptions import ServiceInitializationError
+
+logger: logging.Logger = logging.getLogger(__name__)
+
+
+class OpenAIChatCompletion(OpenAIConfigBase, OpenAIChatCompletionBase, OpenAITextCompletionBase):
+    """OpenAI Chat completion class."""
+
+    def __init__(
+        self,
+        ai_model_id: str | None = None,
+        service_id: str | None = None,
+        api_key: str | None = None,
+        org_id: str | None = None,
+        default_headers: Mapping[str, str] | None = None,
+        async_client: AsyncOpenAI | None = None,
+        env_file_path: str | None = None,
+        env_file_encoding: str | None = None,
+    ) -> None:
+        """Initialize an OpenAIChatCompletion service.
+
+        Args:
+            ai_model_id (str): OpenAI model name, see
+                https://platform.openai.com/docs/models
+            service_id (str | None): Service ID tied to the execution settings.
+            api_key (str | None): The optional API key to use. If provided will override,
+                the env vars or .env file value.
+            org_id (str | None): The optional org ID to use. If provided will override,
+                the env vars or .env file value.
+            default_headers: The default headers mapping of string keys to
+                string values for HTTP requests. (Optional)
+            async_client (Optional[AsyncOpenAI]): An existing client to use. (Optional)
+            env_file_path (str | None): Use the environment settings file as a fallback
+                to environment variables. (Optional)
+            env_file_encoding (str | None): The encoding of the environment settings file. (Optional)
+        """
+        try:
+            openai_settings = OpenAISettings.create(
+                api_key=api_key,
+                org_id=org_id,
+                chat_model_id=ai_model_id,
+                env_file_path=env_file_path,
+                env_file_encoding=env_file_encoding,
+            )
+        except ValidationError as ex:
+            raise ServiceInitializationError("Failed to create OpenAI settings.", ex) from ex
+
+        if not async_client and not openai_settings.api_key:
+            raise ServiceInitializationError("The OpenAI API key is required.")
+        if not openai_settings.chat_model_id:
+            raise ServiceInitializationError("The OpenAI model ID is required.")
+
+        super().__init__(
+            ai_model_id=openai_settings.chat_model_id,
+            api_key=openai_settings.api_key.get_secret_value() if openai_settings.api_key else None,
+            org_id=openai_settings.org_id,
+            service_id=service_id,
+            ai_model_type=OpenAIModelTypes.CHAT,
+            default_headers=default_headers,
+            client=async_client,
+        )
+
+    @classmethod
+    def from_dict(cls, settings: dict[str, Any]) -> "OpenAIChatCompletion":
+        """Initialize an Open AI service from a dictionary of settings.
+
+        Args:
+            settings: A dictionary of settings for the service.
+        """
+        return OpenAIChatCompletion(
+            ai_model_id=settings["ai_model_id"],
+            service_id=settings.get("service_id"),
+            default_headers=settings.get("default_headers"),
+        )