From 40e37b7a3eb827f153f2ed0b2aa492e30e7c54ef Mon Sep 17 00:00:00 2001 From: Tao Chen Date: Wed, 20 Nov 2024 08:04:49 -0800 Subject: [PATCH] Format tables --- python/samples/concepts/setup/ALL_SETTINGS.md | 45 +++++-------------- 1 file changed, 12 insertions(+), 33 deletions(-) diff --git a/python/samples/concepts/setup/ALL_SETTINGS.md b/python/samples/concepts/setup/ALL_SETTINGS.md index 3396a107ae89..1f2536ad4738 100644 --- a/python/samples/concepts/setup/ALL_SETTINGS.md +++ b/python/samples/concepts/setup/ALL_SETTINGS.md @@ -38,41 +38,20 @@ ## Memory Service Settings used across SK: -| Service | Class | Constructor Settings | Environment Variable | Required? | Settings Class | +| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class | | --- | --- | --- | --- | --- | --- | -AstraDB | [AstraDBMemoryService](../../../semantic_kernel/connectors/memory/astradb/astradb_memory_store.py) | | | | [AstraDBSettings](../../../semantic_kernel/connectors/memory/astradb/astradb_settings.py) -| | | app_token | ASTRADB_APP_TOKEN | Yes -| | | db_id | ASTRADB_DB_ID | Yes -| | | region | ASTRADB_REGION | Yes -| | | keyspace | ASTRADB_KEYSPACE | Yes -Azure AI Search | [AzureAISearchMemoryService](../../../semantic_kernel/connectors/memory/azure_cognitive_search/azure_cognitive_search_memory_store.py) | | | | [AzureAISearchSettings](../../../semantic_kernel/connectors/memory/azure_cognitive_search/azure_ai_search_settings.py) -| | | 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](../../../semantic_kernel/connectors/memory/azure_cosmosdb/azure_cosmos_db_memory_store.py) | | | | [AzureCosmosDBSettings](../../../semantic_kernel/connectors/memory/azure_cosmosdb/azure_cosmosdb_settings.py) -| | | api | AZURE_COSMOS_DB_API | No -| | | connection_string | AZURE_COSMOS_DB_CONNECTION_STRING or AZCOSMOS_CONNSTR | No -Mongo DB Atlas | [MongoDBAtlasMemoryService](../../../semantic_kernel/connectors/memory/mongodb_atlas/mongodb_atlas_memory_store.py) | | | | [MongoDBAtlasSettings](../../../semantic_kernel/connectors/memory/mongodb_atlas/mongodb_atlas_settings.py) -| | | connection_string | MONGODB_ATLAS_CONNECTION_STRING | Yes -| | | database_name | MONGODB_ATLAS_DATABASE_NAME | No -| | | index_name | MONGODB_ATLAS_INDEX_NAME | No -Pinecone | [PineconeMemoryService](../../../semantic_kernel/connectors/memory/pinecone/pinecone_memory_store.py) | | | | [PineconeSettings](../../../semantic_kernel/connectors/memory/pinecone/pinecone_settings.py) -| | | api_key | PINECONE_API_KEY | Yes -Postgres | [PostgresMemoryService](../../../semantic_kernel/connectors/memory/postgres/postgres_memory_store.py) | | | | [PostgresSettings](../../../semantic_kernel/connectors/memory/postgres/postgres_settings.py) -| | | connection_string | POSTGRES_CONNECTION_STRING | Yes -Redis | [RedisMemoryService](../../../semantic_kernel/connectors/memory/redis/redis_memory_store.py) | | | | [RedisSettings](../../../semantic_kernel/connectors/memory/redis/redis_settings.py) -| | | connection_string | REDIS_CONNECTION_STRING | Yes -Weaviate | [WeaviateMemoryService](../../../semantic_kernel/connectors/memory/weaviate/weaviate_memory_store.py) | | | | [WeaviateSettings](../../../semantic_kernel/connectors/memory/weaviate/weaviate_settings.py) -| | | url | WEAVIATE_URL | No -| | | api_key | WEAVIATE_API_KEY | No -| | | use_embed | WEAVIATE_USE_EMBED | No +| 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: -| Service | Class | Constructor Settings | Environment Variable | Required? | Settings Class | +| Provider | Service | Constructor Settings | Environment Variable | Required? | Settings Class | | --- | --- | --- | --- | --- | --- | -Bing | [BingSearch](../../../semantic_kernel/connectors/search_engine/bing_connector.py) | | | | [BingSettings](../../../semantic_kernel/connectors/search_engine/bing_connector_settings.py) -| | | api_key | BING_API_KEY | No -| | | custom_config | BING_CUSTOM_CONFIG | No -Azure Container Apps Sessions | [ACASessionsPlugin](../../../semantic_kernel/core_plugins/sessions_python_tool/sessions_python_plugin.py) | | | | [ACASessionsSettings](../../../semantic_kernel/core_plugins/sessions_python_tool/sessions_python_settings.py) -| | | pool_management_endpoint | ACA_POOL_MANAGEMENT_ENDPOINT | Yes +| 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) |