Skip to content

Latest commit

 

History

History
83 lines (78 loc) · 6.27 KB

ALL_SETTINGS.md

File metadata and controls

83 lines (78 loc) · 6.27 KB

AI Service Settings used across SK:

Service Class Constructor Settings Environment Variable Required? Settings Class
OpenAI OpenAIChatCompletion OpenAISettings
ai_model_id OPENAI_CHAT_MODEL_ID Yes
api_key OPENAI_API_KEY Yes
org_id OPENAI_ORG_ID No
OpenAITextCompletion
ai_model_id OPENAI_TEXT_MODEL_ID Yes
api_key OPENAI_API_KEY Yes
org_id OPENAI_ORG_ID No
OpenAITextEmbedding
ai_model_id OPENAI_EMBEDDING_MODEL_ID Yes
api_key OPENAI_API_KEY Yes
org_id OPENAI_ORG_ID No
OpenAITextToImage
ai_model_id OPENAI_TEXT_TO_IMAGE_MODEL_ID Yes
api_key OPENAI_API_KEY Yes
org_id OPENAI_ORG_ID No
Azure OpenAI AzureOpenAIChatCompletion AzureOpenAISettings
deployment_name AZURE_OPENAI_CHAT_DEPLOYMENT_NAME Yes
api_key AZURE_OPENAI_API_KEY Yes
endpoint AZURE_OPENAI_ENDPOINT Yes
api_version AZURE_OPENAI_API_VERSION Yes
base_url AZURE_OPENAI_BASE_URL Yes
AzureOpenAITextCompletion
deployment_name AZURE_OPENAI_TEXT_DEPLOYMENT_NAME Yes
api_key AZURE_OPENAI_API_KEY Yes
endpoint AZURE_OPENAI_ENDPOINT Yes
api_version AZURE_OPENAI_API_VERSION Yes
base_url AZURE_OPENAI_BASE_URL Yes
AzureOpenAITextEmbedding
deployment_name AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME Yes
api_key AZURE_OPENAI_API_KEY Yes
endpoint AZURE_OPENAI_ENDPOINT Yes
api_version AZURE_OPENAI_API_VERSION Yes
base_url AZURE_OPENAI_BASE_URL Yes
AzureTextToImage
deployment_name AZURE_OPENAI_TEXT_TO_IMAGE_DEPLOYMENT_NAME Yes
api_key AZURE_OPENAI_API_KEY Yes
endpoint AZURE_OPENAI_ENDPOINT Yes

Memory Service Settings used across SK:

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

Other settings used:

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