diff --git a/api/configs/feature/__init__.py b/api/configs/feature/__init__.py index c220b98762..f9c1bd4224 100644 --- a/api/configs/feature/__init__.py +++ b/api/configs/feature/__init__.py @@ -33,7 +33,7 @@ class CodeExecutionSandboxConfig(BaseModel): Code Execution Sandbox configs """ CODE_EXECUTION_ENDPOINT: str = Field( - description='whether to enable HTTP response compression of gzip', + description='endpoint URL of code execution servcie', default='http://sandbox:8194', ) diff --git a/api/configs/middleware/__init__.py b/api/configs/middleware/__init__.py index c454f4e603..b6f962e3d5 100644 --- a/api/configs/middleware/__init__.py +++ b/api/configs/middleware/__init__.py @@ -2,7 +2,7 @@ from typing import Any, Optional from pydantic import BaseModel, Field, NonNegativeInt, PositiveInt, computed_field -from configs.middleware.redis_config import RedisConfig +from configs.middleware.cache.redis_config import RedisConfig from configs.middleware.storage.aliyun_oss_storage_config import AliyunOSSStorageConfig from configs.middleware.storage.amazon_s3_storage_config import S3StorageConfig from configs.middleware.storage.azure_blob_storage_config import AzureBlobStorageConfig diff --git a/api/configs/middleware/cache/__init__.py b/api/configs/middleware/cache/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/api/configs/middleware/redis_config.py b/api/configs/middleware/cache/redis_config.py similarity index 100% rename from api/configs/middleware/redis_config.py rename to api/configs/middleware/cache/redis_config.py diff --git a/api/configs/middleware/storage/aliyun_oss_storage_config.py b/api/configs/middleware/storage/aliyun_oss_storage_config.py index 67921149d6..a468f28ea0 100644 --- a/api/configs/middleware/storage/aliyun_oss_storage_config.py +++ b/api/configs/middleware/storage/aliyun_oss_storage_config.py @@ -9,31 +9,31 @@ class AliyunOSSStorageConfig(BaseModel): """ ALIYUN_OSS_BUCKET_NAME: Optional[str] = Field( - description='Aliyun storage ', + description='Aliyun OSS bucket name', default=None, ) ALIYUN_OSS_ACCESS_KEY: Optional[str] = Field( - description='Aliyun storage access key', + description='Aliyun OSS access key', default=None, ) ALIYUN_OSS_SECRET_KEY: Optional[str] = Field( - description='Aliyun storage secret key', + description='Aliyun OSS secret key', default=None, ) ALIYUN_OSS_ENDPOINT: Optional[str] = Field( - description='Aliyun storage endpoint URL', + description='Aliyun OSS endpoint URL', default=None, ) ALIYUN_OSS_REGION: Optional[str] = Field( - description='Aliyun storage region', + description='Aliyun OSS region', default=None, ) ALIYUN_OSS_AUTH_VERSION: Optional[str] = Field( - description='Aliyun storage authentication version', + description='Aliyun OSS authentication version', default=None, ) diff --git a/api/configs/middleware/storage/azure_blob_storage_config.py b/api/configs/middleware/storage/azure_blob_storage_config.py index a37aa496f1..2fcb0ea3bd 100644 --- a/api/configs/middleware/storage/azure_blob_storage_config.py +++ b/api/configs/middleware/storage/azure_blob_storage_config.py @@ -24,6 +24,6 @@ class AzureBlobStorageConfig(BaseModel): ) AZURE_BLOB_ACCOUNT_URL: Optional[str] = Field( - description='Azure Blob account url', + description='Azure Blob account URL', default=None, ) diff --git a/api/configs/middleware/vdb/milvus_config.py b/api/configs/middleware/vdb/milvus_config.py index 88855db877..6c1cda5ee9 100644 --- a/api/configs/middleware/vdb/milvus_config.py +++ b/api/configs/middleware/vdb/milvus_config.py @@ -29,11 +29,11 @@ class MilvusConfig(BaseModel): ) MILVUS_SECURE: bool = Field( - description='wheter to use SSL connection for Milvus', + description='whether to use SSL connection for Milvus', default=False, ) MILVUS_DATABASE: str = Field( - description='Milvus database', + description='Milvus database, default to `default`', default='default', ) diff --git a/api/configs/middleware/vdb/tencent_vector_config.py b/api/configs/middleware/vdb/tencent_vector_config.py index 083f10b40b..64ce2243c9 100644 --- a/api/configs/middleware/vdb/tencent_vector_config.py +++ b/api/configs/middleware/vdb/tencent_vector_config.py @@ -14,12 +14,12 @@ class TencentVectorDBConfig(BaseModel): ) TENCENT_VECTOR_DB_API_KEY: Optional[str] = Field( - description='Tencent Vector api key', + description='Tencent Vector API key', default=None, ) TENCENT_VECTOR_DB_TIMEOUT: PositiveInt = Field( - description='Tencent Vector timeout', + description='Tencent Vector timeout in seconds', default=30, )