Skip to content

Files

60 lines (54 loc) · 13 KB

ALL_SETTINGS.md

File metadata and controls

60 lines (54 loc) · 13 KB

Semantic Kernel Settings

AI Service Settings used across SK

Provider Service Constructor Settings Environment Variable Required? Settings Class
OpenAI OpenAIChatCompletion ai_model_id,
api_key,
org_id
OPENAI_CHAT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID
Yes,
Yes,
No
OpenAISettings
OpenAITextCompletion ai_model_id,
api_key,
org_id
OPENAI_TEXT_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID
Yes,
Yes,
No
OpenAITextEmbedding ai_model_id,
api_key,
org_id
OPENAI_EMBEDDING_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID
Yes,
Yes,
No
OpenAITextToImage ai_model_id,
api_key,
org_id
OPENAI_TEXT_TO_IMAGE_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID
Yes,
Yes,
No
OpenAITextToAudio ai_model_id,
api_key,
org_id
OPENAI_TEXT_TO_AUDIO_MODEL_ID,
OPENAI_API_KEY,
OPENAI_ORG_ID
Yes,
Yes,
No
OpenAIAudioToText 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 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
AzureTextCompletion deployment_name,
api_key,
endpoint,
api_version,
base_url
AZURE_OPENAI_TEXT_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT,
AZURE_OPENAI_API_VERSION,
AZURE_OPENAI_BASE_URL
Yes,
No,
Yes,
Yes,
Yes
AzureTextEmbedding 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 deployment_name,
api_key,
endpoint
AZURE_OPENAI_TEXT_TO_IMAGE_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT
Yes,
No,
Yes
AzureTextToAudio deployment_name,
api_key,
endpoint
AZURE_OPENAI_TEXT_TO_AUDIO_DEPLOYMENT_NAME,
AZURE_OPENAI_API_KEY,
AZURE_OPENAI_ENDPOINT
Yes,
No,
Yes
AzureAudioToText 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 ai_model_id,
api_key,
endpoint
N/A,
AZURE_AI_INFERENCE_API_KEY,
AZURE_AI_INFERENCE_ENDPOINT
Yes,
No,
Yes
AzureAIInferenceSettings
AzureAIInferenceTextEmbedding ai_model_id,
api_key,
endpoint
N/A,
AZURE_AI_INFERENCE_API_KEY,
AZURE_AI_INFERENCE_ENDPOINT
Yes,
No,
Yes
Anthropic AnthropicChatCompletion api_key,
ai_model_id
ANTHROPIC_API_KEY,
ANTHROPIC_CHAT_MODEL_ID
Yes,
Yes
AnthropicSettings
Bedrock BedrockChatCompletion model_id BEDROCK_CHAT_MODEL_ID Yes BedrockSettings
BedrockTextCompletion model_id BEDROCK_TEXT_MODEL_ID Yes
BedrockTextEmbedding model_id BEDROCK_EMBEDDING_MODEL_ID Yes
Google AI GoogleAIChatCompletion gemini_model_id,
api_key
GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_API_KEY
Yes,
Yes
GoogleAISettings
GoogleAITextCompletion gemini_model_id,
api_key
GOOGLE_AI_GEMINI_MODEL_ID,
GOOGLE_AI_API_KEY
Yes,
Yes
GoogleAITextEmbedding embedding_model_id,
api_key
GOOGLE_AI_EMBEDDING_MODEL_ID,
GOOGLE_AI_API_KEY
Yes,
Yes
Vertex AI VertexAIChatCompletion project_id,
region,
gemini_model_id
VERTEX_AI_PROJECT_ID,
VERTEX_AI_REGION,
VERTEX_AI_GEMINI_MODEL_ID
Yes,
No,
Yes
VertexAISettings
VertexAITextCompletion project_id,
region,
gemini_model_id
VERTEX_AI_PROJECT_ID,
VERTEX_AI_REGION,
VERTEX_AI_GEMINI_MODEL_ID
Yes,
No,
Yes
VertexAITextEmbedding project_id,
region,
embedding_model_id
VERTEX_AI_PROJECT_ID,
VERTEX_AI_REGION,
VERTEX_AI_EMBEDDING_MODEL_ID
Yes,
No,
Yes
HuggingFace HuggingFaceTextCompletion ai_model_id N/A Yes
HuggingFaceTextEmbedding ai_model_id N/A Yes
NVIDIA NIM NvidiaTextEmbedding ai_model_id,
api_key,
base_url
NVIDIA_API_KEY,
NVIDIA_TEXT_EMBEDDING_MODEL_ID,
NVIDIA_BASE_URL
Yes NvidiaAISettings
Mistral AI MistralAIChatCompletion ai_model_id,
api_key
MISTRALAI_CHAT_MODEL_ID,
MISTRALAI_API_KEY
Yes,
Yes
MistralAISettings
MistralAITextEmbedding ai_model_id,
api_key
MISTRALAI_EMBEDDING_MODEL_ID,
MISTRALAI_API_KEY
Yes,
Yes
Ollama OllamaChatCompletion ai_model_id,
host
OLLAMA_CHAT_MODEL_ID,
OLLAMA_HOST
Yes,
No
OllamaSettings
OllamaTextCompletion ai_model_id,
host
OLLAMA_TEXT_MODEL_ID,
OLLAMA_HOST
Yes,
No
OllamaTextEmbedding ai_model_id,
host
OLLAMA_EMBEDDING_MODEL_ID,
OLLAMA_HOST
Yes,
No
Onnx OnnxGenAIChatCompletion template,
ai_model_path
N/A,
ONNX_GEN_AI_CHAT_MODEL_FOLDER
Yes,
Yes
OnnxGenAISettings
OnnxGenAITextCompletion ai_model_path ONNX_GEN_AI_TEXT_MODEL_FOLDER Yes

Memory Service Settings used across SK

Provider Service Constructor Settings Environment Variable Required? Settings Class
AstraDB AstraDBMemoryService app_token,
db_id,
region,
keyspace
ASTRADB_APP_TOKEN,
ASTRADB_DB_ID,
ASTRADB_REGION,
ASTRADB_KEYSPACE
Yes,
Yes,
Yes,
Yes
AstraDBSettings
Azure AI Search AzureAISearchMemoryService api_key,
endpoint,
index_name
AZURE_AI_SEARCH_API_KEY,
AZURE_AI_SEARCH_ENDPOINT,
AZURE_AI_SEARCH_INDEX_NAME
No,
Yes,
No
AzureAISearchSettings
Azure Cosmos DB AzureCosmosDBMemoryService api,
connection_string
AZURE_COSMOS_DB_API,
AZURE_COSMOS_DB_CONNECTION_STRING or AZCOSMOS_CONNSTR
No,
No
AzureCosmosDBSettings
Mongo DB Atlas MongoDBAtlasMemoryService connection_string,
database_name,
index_name
MONGODB_ATLAS_CONNECTION_STRING,
MONGODB_ATLAS_DATABASE_NAME,
MONGODB_ATLAS_INDEX_NAME
Yes,
No,
No
MongoDBAtlasSettings
Pinecone PineconeMemoryService api_key PINECONE_API_KEY Yes PineconeSettings
Postgres PostgresMemoryService connection_string POSTGRES_CONNECTION_STRING Yes PostgresSettings
Redis RedisMemoryService connection_string REDIS_CONNECTION_STRING Yes RedisSettings
Weaviate WeaviateMemoryService url,
api_key,
use_embed
WEAVIATE_URL,
WEAVIATE_API_KEY,
WEAVIATE_USE_EMBED
No,
No,
No
WeaviateSettings

Other settings used

Provider Service Constructor Settings Environment Variable Required? Settings Class
Bing BingSearch api_key,
custom_config
BING_API_KEY,
BING_CUSTOM_CONFIG
No,
No
BingSettings
Azure Container Apps Sessions ACASessionsPlugin pool_management_endpoint ACA_POOL_MANAGEMENT_ENDPOINT Yes ACASessionsSettings