# Semantic Kernel Settings
## AI Service Settings used across SK
| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class |
| --- | --- | --- | --- | --- | --- |
| OpenAI | [OpenAIChatCompletion](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_chat_completion.py) | ai_model_id,
api_key,
org_id | OPENAI_CHAT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | [OpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/open_ai_settings.py) |
| | [OpenAITextCompletion](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_text_completion.py) | ai_model_id,
api_key,
org_id | OPENAI_TEXT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | |
| | [OpenAITextEmbedding](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_text_embedding.py) | ai_model_id,
api_key,
org_id | OPENAI_EMBEDDING_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | |
| | [OpenAITextToImage](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_text_to_image.py) | ai_model_id,
api_key,
org_id | OPENAI_TEXT_TO_IMAGE_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | |
| | [OpenAITextToAudio](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_text_to_audio.py) | ai_model_id,
api_key,
org_id | OPENAI_TEXT_TO_AUDIO_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | |
| | [OpenAIAudioToText](../../../semantic_kernel/connectors/ai/open_ai/services/open_ai_audio_to_text.py) | ai_model_id,
api_key,
org_id | OPENAI_AUDIO_TO_TEXT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | |
| Azure OpenAI | [AzureChatCompletion](../../../semantic_kernel/connectors/ai/open_ai/services/azure_chat_completion.py) | deployment_name,
api_key,
endpoint,
api_version,
base_url | AZURE_OPENAI_CHAT_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT,
AZURE_OPENAI_API_VERSION,
AZURE_OPENAI_BASE_URL | Yes,
No,
Yes,
Yes,
Yes | [AzureOpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/azure_open_ai_settings.py) |
| | [AzureTextEmbedding](../../../semantic_kernel/connectors/ai/open_ai/services/azure_text_embedding.py) | deployment_name,
api_key,
endpoint,
api_version,
base_url | AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT,
AZURE_OPENAI_API_VERSION,
AZURE_OPENAI_BASE_URL | Yes,
No,
Yes,
Yes,
Yes | |
| | [AzureTextToImage](../../../semantic_kernel/connectors/ai/open_ai/services/azure_text_to_image.py) | deployment_name,
api_key,
endpoint | AZURE_OPENAI_TEXT_TO_IMAGE_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT | Yes,
No,
Yes | |
| | [AzureTextToAudio](../../../semantic_kernel/connectors/ai/open_ai/services/azure_text_to_audio.py) | deployment_name,
api_key,
endpoint | AZURE_OPENAI_TEXT_TO_AUDIO_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT | Yes,
No,
Yes | |
| | [AzureAudioToText](../../../semantic_kernel/connectors/ai/open_ai/services/azure_audio_to_text.py) | deployment_name,
api_key,
endpoint | AZURE_OPENAI_AUDIO_TO_TEXT_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT | Yes,
No,
Yes | |
| Azure AI Inference | [AzureAIInferenceChatCompletion](../../../semantic_kernel/connectors/ai/azure_ai_inference/services/azure_ai_inference_chat_completion.py) | ai_model_id,
api_key,
endpoint | N/A,
AZURE_AI_INFERENCE_API_KEY,
AZURE_AI_INFERENCE_ENDPOINT | Yes,
No,
Yes | [AzureAIInferenceSettings](../../../semantic_kernel/connectors/ai/azure_ai_inference/azure_ai_inference_settings.py) |
| | [AzureAIInferenceTextEmbedding](../../../semantic_kernel/connectors/ai/azure_ai_inference/services/azure_ai_inference_text_embedding.py) | ai_model_id,
api_key,
endpoint | N/A,
AZURE_AI_INFERENCE_API_KEY,
AZURE_AI_INFERENCE_ENDPOINT | Yes,
No,
Yes | |
| Anthropic | [AnthropicChatCompletion](../../../semantic_kernel/connectors/ai/anthropic/services/anthropic_chat_completion.py) | api_key,
ai_model_id | ANTHROPIC_API_KEY,
ANTHROPIC_CHAT_MODEL_ID | Yes,
Yes | [AnthropicSettings](../../../semantic_kernel/connectors/ai/anthropic/settings/anthropic_settings.py) |
| Bedrock | [BedrockChatCompletion](../../../semantic_kernel/connectors/ai/bedrock/services/bedrock_chat_completion.py) | model_id | BEDROCK_CHAT_MODEL_ID | Yes | [BedrockSettings](../../../semantic_kernel/connectors/ai/bedrock/bedrock_settings.py) |
| | [BedrockTextCompletion](../../../semantic_kernel/connectors/ai/bedrock/services/bedrock_text_completion.py) | model_id | BEDROCK_TEXT_MODEL_ID | Yes | |
| | [BedrockTextEmbedding](../../../semantic_kernel/connectors/ai/bedrock/services/bedrock_text_embedding.py) | model_id | BEDROCK_EMBEDDING_MODEL_ID | Yes | |
| Google AI | [GoogleAIChatCompletion](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py) | gemini_model_id,
api_key | GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_API_KEY | Yes,
Yes | [GoogleAISettings](../../../semantic_kernel/connectors/ai/google/google_ai/google_ai_settings.py) |
| | [GoogleAITextCompletion](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py) | gemini_model_id,
api_key | GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_API_KEY | Yes,
Yes | |
| | [GoogleAITextEmbedding](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py) | embedding_model_id,
api_key | GOOGLE_AI_EMBEDDING_MODEL_ID,
GOOGLE_AI_API_KEY | Yes,
Yes | |
| Vertex AI | [GoogleAIChatCompletion](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_chat_completion.py) | project_id,
region,
gemini_model_id | GOOGLE_AI_CLOUD_PROJECT_ID,
GOOGLE_AI_CLOUD_REGION,
GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_USE_VERTEXAI | Yes,
No,
Yes,
Yes (must set to true) | [GoogleAISettings](../../../semantic_kernel/connectors/ai/google/google_ai/google_ai_settings.py) |
| | [GoogleAITextCompletion](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_completion.py) | project_id,
region,
gemini_model_id | GOOGLE_AI_CLOUD_PROJECT_ID,
GOOGLE_AI_CLOUD_REGION,
GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_USE_VERTEXAI | Yes,
No,
Yes,
Yes (must set to true) | |
| | [GoogleAITextEmbedding](../../../semantic_kernel/connectors/ai/google/google_ai/services/google_ai_text_embedding.py) | project_id,
region,
embedding_model_id | GOOGLE_AI_CLOUD_PROJECT_ID,
GOOGLE_AI_CLOUD_REGION,
GOOGLE_AI_EMBEDDING_MODEL_ID,
GOOGLE_AI_USE_VERTEXAI | Yes,
No,
Yes,
Yes (must set to true) | |
| HuggingFace | [HuggingFaceTextCompletion](../../../semantic_kernel/connectors/ai/hugging_face/services/hf_text_completion.py) | ai_model_id | N/A | Yes | |
| | [HuggingFaceTextEmbedding](../../../semantic_kernel/connectors/ai/hugging_face/services/hf_text_embedding.py) | ai_model_id | N/A | Yes | |
| NVIDIA NIM | [NvidiaChatCompletion](../../../semantic_kernel/connectors/ai/nvidia/services/nvidia_chat_completion.py) | ai_model_id,
api_key,
base_url | NVIDIA_CHAT_MODEL_ID,
NVIDIA_API_KEY,
NVIDIA_BASE_URL | Yes (default: meta/llama-3.1-8b-instruct),
Yes,
No | [NvidiaAISettings](../../../semantic_kernel/connectors/ai/nvidia/settings/nvidia_settings.py) |
| | [NvidiaTextEmbedding](../../../semantic_kernel/connectors/ai/nvidia/services/nvidia_text_embedding.py) | ai_model_id,
api_key,
base_url | NVIDIA_API_KEY,
NVIDIA_TEXT_EMBEDDING_MODEL_ID,
NVIDIA_BASE_URL | Yes | [NvidiaAISettings](../../../semantic_kernel/connectors/ai/nvidia/settings/nvidia_settings.py) |
| Mistral AI | [MistralAIChatCompletion](../../../semantic_kernel/connectors/ai/mistral_ai/services/mistral_ai_chat_completion.py) | ai_model_id,
api_key | MISTRALAI_CHAT_MODEL_ID,
MISTRALAI_API_KEY | Yes,
Yes | [MistralAISettings](../../../semantic_kernel/connectors/ai/mistral_ai/settings/mistral_ai_settings.py) |
| | [MistralAITextEmbedding](../../../semantic_kernel/connectors/ai/mistral_ai/services/mistral_ai_text_embedding.py) | ai_model_id,
api_key | MISTRALAI_EMBEDDING_MODEL_ID,
MISTRALAI_API_KEY | Yes,
Yes | |
| Ollama | [OllamaChatCompletion](../../../semantic_kernel/connectors/ai/ollama/services/ollama_chat_completion.py) | ai_model_id,
host | OLLAMA_CHAT_MODEL_ID,
OLLAMA_HOST | Yes,
No | [OllamaSettings](../../../semantic_kernel/connectors/ai/ollama/ollama_settings.py) |
| | [OllamaTextCompletion](../../../semantic_kernel/connectors/ai/ollama/services/ollama_text_completion.py) | ai_model_id,
host | OLLAMA_TEXT_MODEL_ID,
OLLAMA_HOST | Yes,
No | |
| | [OllamaTextEmbedding](../../../semantic_kernel/connectors/ai/ollama/services/ollama_text_embedding.py) | ai_model_id,
host | OLLAMA_EMBEDDING_MODEL_ID,
OLLAMA_HOST | Yes,
No | |
| Onnx | [OnnxGenAIChatCompletion](../../../semantic_kernel/connectors/ai/onnx/services/onnx_gen_ai_chat_completion.py) | template,
ai_model_path | N/A,
ONNX_GEN_AI_CHAT_MODEL_FOLDER | Yes,
Yes | [OnnxGenAISettings](../../../semantic_kernel/connectors/ai/onnx/onnx_gen_ai_settings.py) |
| | [OnnxGenAITextCompletion](../../../semantic_kernel/connectors/ai/onnx/services/onnx_gen_ai_text_completion.py) | ai_model_path | ONNX_GEN_AI_TEXT_MODEL_FOLDER | Yes | |
## Agent Framework Settings used across SK
| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class |
| --- | --- | --- | --- | --- | --- |
| OpenAI | [OpenAIAssistantAgent](../../../semantic_kernel/agents/open_ai/openai_assistant_agent.py) | ai_model_id,
api_key,
org_id | OPENAI_CHAT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | [OpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/open_ai_settings.py) |
| | [OpenAIResponsesAgent](../../../semantic_kernel/agents/open_ai/openai_responses_agent.py) | ai_model_id,
api_key,
org_id | OPENAI_RESPONSES_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID | Yes,
Yes,
No | [OpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/open_ai_settings.py) |
| Azure OpenAI | [AzureAssistantAgent](../../../semantic_kernel/agents/open_ai/azure_assistant_agent.py) | deployment_name,
api_key,
endpoint,
api_version,
base_url | AZURE_OPENAI_CHAT_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT,
AZURE_OPENAI_API_VERSION,
AZURE_OPENAI_BASE_URL | Yes,
No,
Yes,
Yes,
No | [AzureOpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/azure_open_ai_settings.py) |
| | [AzureResponsesAgent](../../../semantic_kernel/agents/open_ai/azure_responses_agent.py) | deployment_name,
api_key,
endpoint,
api_version,
base_url | AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT,
AZURE_OPENAI_API_VERSION,
AZURE_OPENAI_BASE_URL | Yes,
No,
Yes,
Yes,
No | [AzureOpenAISettings](../../../semantic_kernel/connectors/ai/open_ai/settings/azure_open_ai_settings.py) |
| Azure AI | [AzureAIAgent](../../../semantic_kernel/agents/azure_ai/azure_ai_agent.py) | model_deployment_name,
endpoint,
agent_id,
bing_connection_id,
azure_ai_search_connection_id,
azure_ai_search_index_name,
api_version | AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME,
AZURE_AI_AGENT_ENDPOINT,
AZURE_AI_AGENT_AGENT_ID,
AZURE_AI_AGENT_BING_CONNECTION_ID,
AZURE_AI_AGENT_AZURE_AI_SEARCH_CONNECTION_ID,
AZURE_AI_AGENT_AZURE_AI_SEARCH_INDEX_NAME,
AZURE_AI_AGENT_API_VERSION | Yes,
Yes,
No,
No,
No,
No,
No | [AzureAIAgentSettings](../../../semantic_kernel/agents/azure_ai/azure_ai_agent_settings.py) |
| Bedrock | [BedrockAgent](../../../semantic_kernel/agents/bedrock/bedrock_agent.py) | agent_resource_role_arn,
foundation_model | BEDROCK_AGENT_AGENT_RESOURCE_ROLE_ARN,
BEDROCK_AGENT_FOUNDATION_MODEL | Yes,
Yes | [BedrockAgentSettings](../../../semantic_kernel/agents/bedrock/bedrock_agent_settings.py) |
| Copilot Studio | [CopilotStudioAgent](../../../semantic_kernel/agents/copilot_studio/copilot_studio_agent.py) | app_client_id,
tenant_id,
environment_id,
agent_identifier,
cloud,
copilot_agent_type,
custom_power_platform_cloud,
client_secret,
client_certificate,
user_assertion,
auth_mode | COPILOT_STUDIO_AGENT_APP_CLIENT_ID,
COPILOT_STUDIO_AGENT_TENANT_ID,
COPILOT_STUDIO_AGENT_ENVIRONMENT_ID,
COPILOT_STUDIO_AGENT_AGENT_IDENTIFIER,
COPILOT_STUDIO_AGENT_CLOUD,
COPILOT_STUDIO_AGENT_COPILOT_AGENT_TYPE,
COPILOT_STUDIO_AGENT_CUSTOM_POWER_PLATFORM_CLOUD,
COPILOT_STUDIO_AGENT_CLIENT_SECRET,
COPILOT_STUDIO_AGENT_CLIENT_CERTIFICATE,
COPILOT_STUDIO_AGENT_USER_ASSERTION,
COPILOT_STUDIO_AGENT_AUTH_MODE | No (varies by mode) | [CopilotStudioAgentSettings](../../../semantic_kernel/agents/copilot_studio/copilot_studio_agent_settings.py) |
## Memory Service Settings used across SK
| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class |
| --- | --- | --- | --- | --- | --- |
| AstraDB | [AstraDBMemoryService](../../../semantic_kernel/connectors/memory/astradb/astradb_memory_store.py) | app_token,
db_id,
region,
keyspace | ASTRADB_APP_TOKEN,
ASTRADB_DB_ID,
ASTRADB_REGION,
ASTRADB_KEYSPACE | Yes,
Yes,
Yes,
Yes | [AstraDBSettings](../../../semantic_kernel/connectors/memory/astradb/astradb_settings.py) |
| Azure AI Search | [AzureAISearchMemoryService](../../../semantic_kernel/connectors/memory/azure_cognitive_search/azure_cognitive_search_memory_store.py) | api_key,
endpoint,
index_name | AZURE_AI_SEARCH_API_KEY,
AZURE_AI_SEARCH_ENDPOINT,
AZURE_AI_SEARCH_INDEX_NAME | No,
Yes,
No | [AzureAISearchSettings](../../../semantic_kernel/connectors/memory/azure_cognitive_search/azure_ai_search_settings.py) |
| Azure Cosmos DB | [AzureCosmosDBMemoryService](../../../semantic_kernel/connectors/memory/azure_cosmosdb/azure_cosmos_db_memory_store.py) | api,
connection_string | AZURE_COSMOS_DB_API,
AZURE_COSMOS_DB_CONNECTION_STRING or AZCOSMOS_CONNSTR | No,
No | [AzureCosmosDBSettings](../../../semantic_kernel/connectors/memory/azure_cosmosdb/azure_cosmosdb_settings.py) |
| Mongo DB Atlas | [MongoDBAtlasMemoryService](../../../semantic_kernel/connectors/memory/mongodb_atlas/mongodb_atlas_memory_store.py) | connection_string,
database_name,
index_name | MONGODB_ATLAS_CONNECTION_STRING,
MONGODB_ATLAS_DATABASE_NAME,
MONGODB_ATLAS_INDEX_NAME | Yes,
No,
No | [MongoDBAtlasSettings](../../../semantic_kernel/connectors/memory/mongodb_atlas/mongodb_atlas_settings.py) |
| Pinecone | [PineconeMemoryService](../../../semantic_kernel/connectors/memory/pinecone/pinecone_memory_store.py) | api_key | PINECONE_API_KEY | Yes | [PineconeSettings](../../../semantic_kernel/connectors/memory/pinecone/pinecone_settings.py) |
| Postgres | [PostgresMemoryService](../../../semantic_kernel/connectors/memory/postgres/postgres_memory_store.py) | connection_string | POSTGRES_CONNECTION_STRING | Yes | [PostgresSettings](../../../semantic_kernel/connectors/memory/postgres/postgres_settings.py) |
| Redis | [RedisMemoryService](../../../semantic_kernel/connectors/memory/redis/redis_memory_store.py) | connection_string | REDIS_CONNECTION_STRING | Yes | [RedisSettings](../../../semantic_kernel/connectors/memory/redis/redis_settings.py) |
| Weaviate | [WeaviateMemoryService](../../../semantic_kernel/connectors/memory/weaviate/weaviate_memory_store.py) | url,
api_key,
use_embed | WEAVIATE_URL,
WEAVIATE_API_KEY,
WEAVIATE_USE_EMBED | No,
No,
No | [WeaviateSettings](../../../semantic_kernel/connectors/memory/weaviate/weaviate_settings.py) |
## Other settings used
| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class |
| --- | --- | --- | --- | --- | --- |
| Bing | [BingSearch](../../../semantic_kernel/connectors/search_engine/bing_connector.py) | api_key,
custom_config | BING_API_KEY,
BING_CUSTOM_CONFIG | No,
No | [BingSettings](../../../semantic_kernel/connectors/search_engine/bing_connector_settings.py) |
| Azure Container Apps Sessions | [ACASessionsPlugin](../../../semantic_kernel/core_plugins/sessions_python_tool/sessions_python_plugin.py) | pool_management_endpoint | ACA_POOL_MANAGEMENT_ENDPOINT | Yes | [ACASessionsSettings](../../../semantic_kernel/core_plugins/sessions_python_tool/sessions_python_settings.py) |