Python: Add AI connector README (#9764)

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
We need a README in the connectors/ai directory to list all the existing
AI connectors.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist
1. Add a README
2. Refactor some connector package paths

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

python/samples/concepts/chat_completion/chat_bedrock_api.py

@@ -3,8 +3,7 @@
 import asyncio
 
 from semantic_kernel import Kernel
-from semantic_kernel.connectors.ai.bedrock.bedrock_prompt_execution_settings import BedrockChatPromptExecutionSettings
-from semantic_kernel.connectors.ai.bedrock.services.bedrock_chat_completion import BedrockChatCompletion
+from semantic_kernel.connectors.ai.bedrock import BedrockChatCompletion, BedrockChatPromptExecutionSettings
 from semantic_kernel.contents import ChatHistory
 
 system_message = """

python/samples/concepts/local_models/lm_studio_chat_completion.py

@@ -5,7 +5,7 @@
 
 from openai import AsyncOpenAI
 
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion import OpenAIChatCompletion
+from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion
 from semantic_kernel.contents.chat_history import ChatHistory
 from semantic_kernel.functions.kernel_arguments import KernelArguments
 from semantic_kernel.kernel import Kernel

python/samples/concepts/local_models/lm_studio_text_embedding.py

@@ -4,7 +4,7 @@
 
 from openai import AsyncOpenAI
 
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding import OpenAITextEmbedding
+from semantic_kernel.connectors.ai.open_ai import OpenAITextEmbedding
 from semantic_kernel.core_plugins.text_memory_plugin import TextMemoryPlugin
 from semantic_kernel.kernel import Kernel
 from semantic_kernel.memory.semantic_text_memory import SemanticTextMemory

python/samples/concepts/local_models/ollama_chat_completion.py

@@ -5,7 +5,7 @@
 
 from openai import AsyncOpenAI
 
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion import OpenAIChatCompletion
+from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion
 from semantic_kernel.contents.chat_history import ChatHistory
 from semantic_kernel.functions.kernel_arguments import KernelArguments
 from semantic_kernel.kernel import Kernel

python/samples/concepts/model_as_a_service/mmlu_model_eval.py

@@ -12,9 +12,7 @@
     formatted_question,
     formatted_system_message,
 )
-from semantic_kernel.connectors.ai.azure_ai_inference.services.azure_ai_inference_chat_completion import (
-    AzureAIInferenceChatCompletion,
-)
+from semantic_kernel.connectors.ai.azure_ai_inference import AzureAIInferenceChatCompletion
 from semantic_kernel.connectors.ai.chat_completion_client_base import ChatCompletionClientBase
 from semantic_kernel.contents.chat_history import ChatHistory
 from semantic_kernel.functions.kernel_arguments import KernelArguments

python/semantic_kernel/connectors/ai/README.md

@@ -0,0 +1,52 @@
+# AI Connectors
+
+This directory contains the implementation of the AI connectors (aka AI services) that are used to interact with AI models.
+
+Depending on the modality, the AI connector can inherit from one of the following classes:
+- [`ChatCompletionClientBase`](./chat_completion_client_base.py) for chat completion tasks.
+- [`TextCompletionClientBase`](./text_completion_client_base.py) for text completion tasks.
+- [`AudioToTextClientBase`](./audio_to_text_client_base.py) for audio to text tasks.
+- [`TextToAudioClientBase`](./text_to_audio_client_base.py) for text to audio tasks.
+- [`TextToImageClientBase`](./text_to_image_client_base.py) for text to image tasks.
+- [`EmbeddingGeneratorBase`](./embeddings/embedding_generator_base.py) for text embedding tasks.
+
+
+All base clients inherit from the [`AIServiceClientBase`](../../services/ai_service_client_base.py) class.
+
+## Existing AI connectors
+
+| Services          | Connectors                          |
+|-------------------------|--------------------------------------|
+| OpenAI     | [`OpenAIChatCompletion`](./open_ai/services/open_ai_chat_completion.py) |
+|            | [`OpenAITextCompletion`](./open_ai/services/open_ai_text_completion.py) |
+|            | [`OpenAITextEmbedding`](./open_ai/services/open_ai_text_embedding.py) |
+|            | [`OpenAITextToImage`](./open_ai/services/open_ai_text_to_image.py) |
+|            | [`OpenAITextToAudio`](./open_ai/services/open_ai_text_to_audio.py) |
+|            | [`OpenAIAudioToText`](./open_ai/services/open_ai_audio_to_text.py) |
+| Azure OpenAI | [`AzureChatCompletion`](./open_ai/services/azure_chat_completion.py) |
+|            | [`AzureTextCompletion`](./open_ai/services/azure_text_completion.py) |
+|            | [`AzureTextEmbedding`](./open_ai/services/azure_text_embedding.py) |
+|            | [`AzureTextToImage`](./open_ai/services/azure_text_to_image.py) |
+|            | [`AzureTextToAudio`](./open_ai/services/azure_text_to_audio.py) |
+|            | [`AzureAudioToText`](./open_ai/services/azure_audio_to_text.py) |
+| Azure AI Inference | [`AzureAIInferenceChatCompletion`](./azure_ai_inference/services/azure_ai_inference_chat_completion.py) |
+|            | [`AzureAIInferenceTextEmbedding`](./azure_ai_inference/services/azure_ai_inference_text_embedding.py) |
+| Anthropic | [`AnthropicChatCompletion`](./anthropic/services/anthropic_chat_completion.py) |
+| [Bedrock](./bedrock/README.md) | [`BedrockChatCompletion`](./bedrock/services/bedrock_chat_completion.py) |
+|         | [`BedrockTextCompletion`](./bedrock/services/bedrock_text_completion.py) |
+|         | [`BedrockTextEmbedding`](./bedrock/services/bedrock_text_embedding.py) |
+| [Google AI](./google/README.md) | [`GoogleAIChatCompletion`](./google/google_ai/services/google_ai_chat_completion.py) |
+|           | [`GoogleAITextCompletion`](./google/google_ai/services/google_ai_text_completion.py) |
+|           | [`GoogleAITextEmbedding`](./google/google_ai/services/google_ai_text_embedding.py) |
+| [Vertex AI](./google/README.md) | [`VertexAIChatCompletion`](./google/vertex_ai/services/vertex_ai_chat_completion.py) |
+|           | [`VertexAITextCompletion`](./google/vertex_ai/services/vertex_ai_text_completion.py) |
+|           | [`VertexAITextEmbedding`](./google/vertex_ai/services/vertex_ai_text_embedding.py) |
+| HuggingFace | [`HuggingFaceTextCompletion`](./hugging_face/services/hf_text_completion.py) |
+|             | [`HuggingFaceTextEmbedding`](./hugging_face/services/hf_text_embedding.py) |
+| Mistral AI | [`MistralAIChatCompletion`](./mistral_ai/services/mistral_ai_chat_completion.py) |
+|            | [`MistralAITextEmbedding`](./mistral_ai/services/mistral_ai_text_embedding.py) |
+| Ollama | [`OllamaChatCompletion`](./ollama/services/ollama_chat_completion.py) |
+|        | [`OllamaTextCompletion`](./ollama/services/ollama_text_completion.py) |
+|        | [`OllamaTextEmbedding`](./ollama/services/ollama_text_embedding.py) |
+| Onnx | [`OnnxGenAIChatCompletion`](./onnx/services/onnx_gen_ai_chat_completion.py) |
+|      | [`OnnxGenAITextCompletion`](./onnx/services/onnx_gen_ai_text_completion.py) |

python/semantic_kernel/connectors/ai/bedrock/__init__.py

@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from semantic_kernel.connectors.ai.bedrock.bedrock_prompt_execution_settings import (
+    BedrockChatPromptExecutionSettings,
+    BedrockEmbeddingPromptExecutionSettings,
+    BedrockPromptExecutionSettings,
+    BedrockTextPromptExecutionSettings,
+)
+from semantic_kernel.connectors.ai.bedrock.bedrock_settings import BedrockSettings
+from semantic_kernel.connectors.ai.bedrock.services.bedrock_chat_completion import BedrockChatCompletion
+from semantic_kernel.connectors.ai.bedrock.services.bedrock_text_completion import BedrockTextCompletion
+from semantic_kernel.connectors.ai.bedrock.services.bedrock_text_embedding import BedrockTextEmbedding
+
+__all__ = [
+    "BedrockChatCompletion",
+    "BedrockChatPromptExecutionSettings",
+    "BedrockEmbeddingPromptExecutionSettings",
+    "BedrockPromptExecutionSettings",
+    "BedrockSettings",
+    "BedrockTextCompletion",
+    "BedrockTextEmbedding",
+    "BedrockTextPromptExecutionSettings",
+]

python/semantic_kernel/connectors/ai/google/google_ai/__init__.py

@@ -4,6 +4,7 @@
     GoogleAIChatPromptExecutionSettings,
     GoogleAIEmbeddingPromptExecutionSettings,
     GoogleAIPromptExecutionSettings,
+    GoogleAITextPromptExecutionSettings,
 )
 from semantic_kernel.connectors.ai.google.google_ai.services.google_ai_chat_completion import GoogleAIChatCompletion
 from semantic_kernel.connectors.ai.google.google_ai.services.google_ai_text_completion import GoogleAITextCompletion
@@ -16,4 +17,5 @@
     "GoogleAIPromptExecutionSettings",
     "GoogleAITextCompletion",
     "GoogleAITextEmbedding",
+    "GoogleAITextPromptExecutionSettings",
 ]

python/semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py

@@ -49,7 +49,7 @@ def __init__(
 
         If no arguments are provided, the service will attempt to load the settings from the environment.
         The following environment variables are used:
-        - GOOGLE_AI_AI_MODEL_ID
+        - GOOGLE_AI_GEMINI_MODEL_ID
         - GOOGLE_AI_API_KEY
 
         Args:

python/semantic_kernel/connectors/ai/google/vertex_ai/__init__.py

@@ -7,6 +7,7 @@
     VertexAIChatPromptExecutionSettings,
     VertexAIEmbeddingPromptExecutionSettings,
     VertexAIPromptExecutionSettings,
+    VertexAITextPromptExecutionSettings,
 )
 
 __all__ = [
@@ -16,4 +17,5 @@
     "VertexAIPromptExecutionSettings",
     "VertexAITextCompletion",
     "VertexAITextEmbedding",
+    "VertexAITextPromptExecutionSettings",
 ]

python/semantic_kernel/connectors/ai/open_ai/__init__.py

@@ -40,6 +40,8 @@
 from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding import OpenAITextEmbedding
 from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_to_audio import OpenAITextToAudio
 from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_to_image import OpenAITextToImage
+from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
+from semantic_kernel.connectors.ai.open_ai.settings.open_ai_settings import OpenAISettings
 
 __all__ = [
     "ApiKeyAuthentication",
@@ -52,6 +54,7 @@
     "AzureCosmosDBDataSourceParameters",
     "AzureDataSourceParameters",
     "AzureEmbeddingDependency",
+    "AzureOpenAISettings",
     "AzureTextCompletion",
     "AzureTextEmbedding",
     "AzureTextToAudio",
@@ -66,6 +69,7 @@
     "OpenAIChatPromptExecutionSettings",
     "OpenAIEmbeddingPromptExecutionSettings",
     "OpenAIPromptExecutionSettings",
+    "OpenAISettings",
     "OpenAITextCompletion",
     "OpenAITextEmbedding",
     "OpenAITextPromptExecutionSettings",

python/tests/integration/completions/chat_completion_test_base.py

@@ -12,42 +12,24 @@
 from azure.identity import DefaultAzureCredential
 from openai import AsyncAzureOpenAI
 
-from semantic_kernel.connectors.ai.anthropic.prompt_execution_settings.anthropic_prompt_execution_settings import (
-    AnthropicChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.anthropic.services.anthropic_chat_completion import AnthropicChatCompletion
-from semantic_kernel.connectors.ai.azure_ai_inference.azure_ai_inference_prompt_execution_settings import (
-    AzureAIInferenceChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.azure_ai_inference.services.azure_ai_inference_chat_completion import (
+from semantic_kernel.connectors.ai.anthropic import AnthropicChatCompletion, AnthropicChatPromptExecutionSettings
+from semantic_kernel.connectors.ai.azure_ai_inference import (
     AzureAIInferenceChatCompletion,
+    AzureAIInferenceChatPromptExecutionSettings,
 )
-from semantic_kernel.connectors.ai.bedrock.bedrock_prompt_execution_settings import BedrockChatPromptExecutionSettings
-from semantic_kernel.connectors.ai.bedrock.services.bedrock_chat_completion import BedrockChatCompletion
+from semantic_kernel.connectors.ai.bedrock import BedrockChatCompletion, BedrockChatPromptExecutionSettings
 from semantic_kernel.connectors.ai.chat_completion_client_base import ChatCompletionClientBase
-from semantic_kernel.connectors.ai.google.google_ai.google_ai_prompt_execution_settings import (
-    GoogleAIChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.google.google_ai.services.google_ai_chat_completion import GoogleAIChatCompletion
-from semantic_kernel.connectors.ai.google.vertex_ai.services.vertex_ai_chat_completion import VertexAIChatCompletion
-from semantic_kernel.connectors.ai.google.vertex_ai.vertex_ai_prompt_execution_settings import (
-    VertexAIChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.mistral_ai.prompt_execution_settings.mistral_ai_prompt_execution_settings import (
-    MistralAIChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.mistral_ai.services.mistral_ai_chat_completion import MistralAIChatCompletion
-from semantic_kernel.connectors.ai.ollama.ollama_prompt_execution_settings import OllamaChatPromptExecutionSettings
-from semantic_kernel.connectors.ai.ollama.services.ollama_chat_completion import OllamaChatCompletion
-from semantic_kernel.connectors.ai.open_ai.prompt_execution_settings.azure_chat_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.google.google_ai import GoogleAIChatCompletion, GoogleAIChatPromptExecutionSettings
+from semantic_kernel.connectors.ai.google.vertex_ai import VertexAIChatCompletion, VertexAIChatPromptExecutionSettings
+from semantic_kernel.connectors.ai.mistral_ai import MistralAIChatCompletion, MistralAIChatPromptExecutionSettings
+from semantic_kernel.connectors.ai.ollama import OllamaChatCompletion, OllamaChatPromptExecutionSettings
+from semantic_kernel.connectors.ai.open_ai import (
+    AzureChatCompletion,
     AzureChatPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.open_ai.prompt_execution_settings.open_ai_prompt_execution_settings import (
+    AzureOpenAISettings,
+    OpenAIChatCompletion,
     OpenAIChatPromptExecutionSettings,
 )
-from semantic_kernel.connectors.ai.open_ai.services.azure_chat_completion import AzureChatCompletion
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion import OpenAIChatCompletion
-from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
 from semantic_kernel.connectors.ai.prompt_execution_settings import PromptExecutionSettings
 from semantic_kernel.contents.chat_history import ChatHistory
 from semantic_kernel.core_plugins.math_plugin import MathPlugin

python/tests/integration/completions/test_text_completion.py

@@ -8,26 +8,17 @@
 import pytest
 from openai import AsyncAzureOpenAI
 
-from semantic_kernel.connectors.ai.bedrock.bedrock_prompt_execution_settings import BedrockTextPromptExecutionSettings
-from semantic_kernel.connectors.ai.bedrock.services.bedrock_text_completion import BedrockTextCompletion
-from semantic_kernel.connectors.ai.google.google_ai.google_ai_prompt_execution_settings import (
-    GoogleAITextPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.google.google_ai.services.google_ai_text_completion import GoogleAITextCompletion
-from semantic_kernel.connectors.ai.google.vertex_ai.services.vertex_ai_text_completion import VertexAITextCompletion
-from semantic_kernel.connectors.ai.google.vertex_ai.vertex_ai_prompt_execution_settings import (
-    VertexAITextPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.hugging_face.hf_prompt_execution_settings import HuggingFacePromptExecutionSettings
-from semantic_kernel.connectors.ai.hugging_face.services.hf_text_completion import HuggingFaceTextCompletion
-from semantic_kernel.connectors.ai.ollama.ollama_prompt_execution_settings import OllamaTextPromptExecutionSettings
-from semantic_kernel.connectors.ai.ollama.services.ollama_text_completion import OllamaTextCompletion
-from semantic_kernel.connectors.ai.open_ai.prompt_execution_settings.open_ai_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.bedrock import BedrockTextCompletion, BedrockTextPromptExecutionSettings
+from semantic_kernel.connectors.ai.google.google_ai import GoogleAITextCompletion, GoogleAITextPromptExecutionSettings
+from semantic_kernel.connectors.ai.google.vertex_ai import VertexAITextCompletion, VertexAITextPromptExecutionSettings
+from semantic_kernel.connectors.ai.hugging_face import HuggingFacePromptExecutionSettings, HuggingFaceTextCompletion
+from semantic_kernel.connectors.ai.ollama import OllamaTextCompletion, OllamaTextPromptExecutionSettings
+from semantic_kernel.connectors.ai.open_ai import (
+    AzureOpenAISettings,
+    AzureTextCompletion,
+    OpenAITextCompletion,
     OpenAITextPromptExecutionSettings,
 )
-from semantic_kernel.connectors.ai.open_ai.services.azure_text_completion import AzureTextCompletion
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_completion import OpenAITextCompletion
-from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
 from semantic_kernel.connectors.ai.text_completion_client_base import TextCompletionClientBase
 from semantic_kernel.contents.chat_message_content import ChatMessageContent
 from semantic_kernel.contents.text_content import TextContent

python/tests/integration/embeddings/test_embedding_service_base.py

@@ -5,35 +5,29 @@
 from azure.identity import DefaultAzureCredential
 from openai import AsyncAzureOpenAI
 
-from semantic_kernel.connectors.ai.azure_ai_inference.azure_ai_inference_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.azure_ai_inference import (
     AzureAIInferenceEmbeddingPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.azure_ai_inference.services.azure_ai_inference_text_embedding import (
     AzureAIInferenceTextEmbedding,
 )
-from semantic_kernel.connectors.ai.bedrock.bedrock_prompt_execution_settings import (
-    BedrockEmbeddingPromptExecutionSettings,
-)
-from semantic_kernel.connectors.ai.bedrock.services.bedrock_text_embedding import BedrockTextEmbedding
+from semantic_kernel.connectors.ai.bedrock import BedrockEmbeddingPromptExecutionSettings, BedrockTextEmbedding
 from semantic_kernel.connectors.ai.embeddings.embedding_generator_base import EmbeddingGeneratorBase
-from semantic_kernel.connectors.ai.google.google_ai.google_ai_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.google.google_ai import (
     GoogleAIEmbeddingPromptExecutionSettings,
+    GoogleAITextEmbedding,
 )
-from semantic_kernel.connectors.ai.google.google_ai.services.google_ai_text_embedding import GoogleAITextEmbedding
-from semantic_kernel.connectors.ai.google.vertex_ai.services.vertex_ai_text_embedding import VertexAITextEmbedding
-from semantic_kernel.connectors.ai.google.vertex_ai.vertex_ai_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.google.vertex_ai import (
     VertexAIEmbeddingPromptExecutionSettings,
+    VertexAITextEmbedding,
 )
-from semantic_kernel.connectors.ai.hugging_face.services.hf_text_embedding import HuggingFaceTextEmbedding
-from semantic_kernel.connectors.ai.mistral_ai.services.mistral_ai_text_embedding import MistralAITextEmbedding
-from semantic_kernel.connectors.ai.ollama.ollama_prompt_execution_settings import OllamaEmbeddingPromptExecutionSettings
-from semantic_kernel.connectors.ai.ollama.services.ollama_text_embedding import OllamaTextEmbedding
-from semantic_kernel.connectors.ai.open_ai.prompt_execution_settings.open_ai_prompt_execution_settings import (
+from semantic_kernel.connectors.ai.hugging_face import HuggingFaceTextEmbedding
+from semantic_kernel.connectors.ai.mistral_ai import MistralAITextEmbedding
+from semantic_kernel.connectors.ai.ollama import OllamaEmbeddingPromptExecutionSettings, OllamaTextEmbedding
+from semantic_kernel.connectors.ai.open_ai import (
+    AzureOpenAISettings,
+    AzureTextEmbedding,
     OpenAIEmbeddingPromptExecutionSettings,
+    OpenAITextEmbedding,
 )
-from semantic_kernel.connectors.ai.open_ai.services.azure_text_embedding import AzureTextEmbedding
-from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding import OpenAITextEmbedding
-from semantic_kernel.connectors.ai.open_ai.settings.azure_open_ai_settings import AzureOpenAISettings
 from semantic_kernel.connectors.ai.prompt_execution_settings import PromptExecutionSettings
 from semantic_kernel.utils.authentication.entra_id_authentication import get_entra_auth_token
 from tests.integration.utils import is_service_setup_for_testing, is_test_running_on_supported_platforms