2
0
zijiren233 9 сар өмнө
parent
commit
6abeb2e722
1 өөрчлөгдсөн 15 нэмэгдсэн , 15 устгасан
  1. 15 15
      README.md

+ 15 - 15
README.md

@@ -19,9 +19,9 @@ docker-compose up -d
 ### Basic Configuration
 
 - `ADMIN_KEY`: The admin key for the AI Proxy Service, admin key is used to admin api and relay api, default is empty
-- `SQL_DSN`: The database connection string, default is empty
-- `LOG_SQL_DSN`: The log database connection string, default is empty
-- `REDIS_CONN_STRING`: The redis connection string, default is empty
+- `SQL_DSN`: The database connection string, default is empty, eg: `postgres://postgres:postgres@localhost:5432/postgres`
+- `LOG_SQL_DSN`: The log database connection string, default is empty, eg: `postgres://postgres:postgres@localhost:5432/postgres`
+- `REDIS_CONN_STRING`: The redis connection string, default is empty, eg: `redis://localhost:6379`
 - `INTERNAL_TOKEN`: Internal token for service authentication, default is empty
 - `FFPROBE_ENABLED`: Whether to enable ffprobe, default is `false`
 
@@ -41,31 +41,31 @@ docker-compose up -d
 
 ### Notify Options
 
-- `NOTIFY_NOTE`: Custom notification note, default is empty
-- `NOTIFY_FEISHU_WEBHOOK`: The feishu notify webhook url, default is empty
+- `NOTIFY_NOTE`: Custom notification note, default is `AI Proxy`
+- `NOTIFY_FEISHU_WEBHOOK`: The feishu notify webhook url, default is empty, eg: `https://open.feishu.cn/open-apis/bot/v2/hook/xxxx`
 
 ### Model Configuration
 
 - `DISABLE_MODEL_CONFIG`: Disable model configuration, default is `false`
-- `RETRY_TIMES`: Number of retry attempts, default is determined at runtime
-- `ENABLE_MODEL_ERROR_AUTO_BAN`: Enable automatic banning of models with errors, default is determined at runtime
+- `RETRY_TIMES`: Number of retry attempts, default is `0`
+- `ENABLE_MODEL_ERROR_AUTO_BAN`: Enable automatic banning of models with errors, default is `false`
 - `MODEL_ERROR_AUTO_BAN_RATE`: Rate threshold for auto-banning models with errors, default is `0.3`
-- `TIMEOUT_WITH_MODEL_TYPE`: Timeout settings for different model types, default is empty map
-- `DEFAULT_CHANNEL_MODELS`: Default models for each channel, default is empty map
-- `DEFAULT_CHANNEL_MODEL_MAPPING`: Model mapping for each channel, default is empty map
+- `TIMEOUT_WITH_MODEL_TYPE`: Timeout settings for different model types, default is `{}`
+- `DEFAULT_CHANNEL_MODELS`: Default models for each channel, default is `{}`
+- `DEFAULT_CHANNEL_MODEL_MAPPING`: Model mapping for each channel, default is `{}`
 
 ### Logging Configuration
 
-- `LOG_STORAGE_HOURS`: Hours to store logs (0 means no limit), default is `0`
-- `SAVE_ALL_LOG_DETAIL`: Save all log details, default is determined at runtime
+- `LOG_STORAGE_HOURS`: Hours to store logs (0 means unlimited), default is `0`
+- `SAVE_ALL_LOG_DETAIL`: Save all log details, default is `false`
 - `LOG_DETAIL_REQUEST_BODY_MAX_SIZE`: Maximum size for request body in log details, default is `128KB`
 - `LOG_DETAIL_RESPONSE_BODY_MAX_SIZE`: Maximum size for response body in log details, default is `128KB`
 - `LOG_DETAIL_STORAGE_HOURS`: Hours to store log details, default is `72` (3 days)
 
 ### Service Control
 
-- `DISABLE_SERVE`: Disable serving requests, default is determined at runtime
-- `GROUP_MAX_TOKEN_NUM`: Maximum number of tokens per group (0 means unlimited), default is determined at runtime
-- `GROUP_CONSUME_LEVEL_RATIO`: Consumption level ratio for groups, default is determined at runtime
+- `DISABLE_SERVE`: Disable serving requests, default false
+- `GROUP_MAX_TOKEN_NUM`: Maximum number of tokens per group (0 means unlimited), default is `0`
+- `GROUP_CONSUME_LEVEL_RATIO`: Consumption level ratio for groups, default is `{}`
 - `GEMINI_SAFETY_SETTING`: Safety setting for Gemini models, default is `BLOCK_NONE`
 - `BILLING_ENABLED`: Enable billing functionality, default is `true`