"vscode:/vscode.git/clone" did not exist on "2ca12a732db90803b5f7f5e79c8938f2504dece3"
Commit 396700dd authored by chenzk's avatar chenzk
Browse files

v1.0

parents
Pipeline #2603 failed with stages
in 0 seconds
---
title: "File Serve Configurations Configuration"
description: "This configuration is for the file serve module. In DB-GPT, you can store yourfiles in the file server."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the file serve module. In DB-GPT, you can store yourfiles in the file server.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "check_hash",
"type": "boolean",
"required": false,
"description": "Check the hash of the file when downloading",
"defaultValue": "True"
},
{
"name": "host",
"type": "string",
"required": false,
"description": "The host of the file server"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "The port of the file server, default is 5670",
"defaultValue": "5670"
},
{
"name": "download_chunk_size",
"type": "integer",
"required": false,
"description": "The chunk size when downloading the file",
"defaultValue": "1048576"
},
{
"name": "save_chunk_size",
"type": "integer",
"required": false,
"description": "The chunk size when saving the file",
"defaultValue": "1048576"
},
{
"name": "transfer_chunk_size",
"type": "integer",
"required": false,
"description": "The chunk size when transferring the file",
"defaultValue": "1048576"
},
{
"name": "transfer_timeout",
"type": "integer",
"required": false,
"description": "The timeout when transferring the file",
"defaultValue": "360"
},
{
"name": "local_storage_path",
"type": "string",
"required": false,
"description": "The local storage path"
},
{
"name": "default_backend",
"type": "string",
"required": false,
"description": "The default storage backend"
},
{
"name": "backends",
"type": "StorageBackendConfig",
"required": false,
"description": "The storage backend configurations",
"nestedTypes": [
{
"type": "link",
"text": "s3 configuration",
"url": "../utils/config_s3storageconfig_f0cdc9"
},
{
"type": "link",
"text": "oss configuration",
"url": "../utils/config_ossstorageconfig_1ad505"
}
],
"defaultValue": "[]"
}
]
}} />
---
title: "Hub dbgpts Serve Configurations Configuration"
description: "This configuration is for the hub dbgpts serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the hub dbgpts serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "Feedback Serve Configurations Configuration"
description: "This configuration is for the feedback serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the feedback serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "serve"
description: "serve Configuration"
---
# serve Configuration
This document provides an overview of all configuration classes in serve type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "ServeConfig",
"description": "This configuration is for the datasource serve module.",
"link": "./config_serveconfig_63f1e9"
},
{
"name": "ServeConfig",
"description": "Parameters for the serve command",
"link": "./config_serveconfig_adbd6f"
},
{
"name": "ServeConfig",
"description": "This configuration is for the conversation serve module.",
"link": "./config_serveconfig_313252"
},
{
"name": "ServeConfig",
"description": "This configuration is for the hub dbgpts serve module.",
"link": "./config_serveconfig_ec2d70"
},
{
"name": "ServeConfig",
"description": "This configuration is for the my dbgpts serve module.",
"link": "./config_serveconfig_1a9284"
},
{
"name": "ServeConfig",
"description": "This configuration is for the evaluate serve module.",
"link": "./config_serveconfig_8839e0"
},
{
"name": "ServeConfig",
"description": "This configuration is for the feedback serve module.",
"link": "./config_serveconfig_fa1f35"
},
{
"name": "ServeConfig",
"description": "This configuration is for the file serve module. In DB-GPT, you can store yourfiles in the file server.",
"link": "./config_serveconfig_cb64c6"
},
{
"name": "ServeConfig",
"description": "This configuration is for the flow serve module.",
"link": "./config_serveconfig_c0b589"
},
{
"name": "ServeConfig",
"description": "This configuration is for the libro serve module.",
"link": "./config_serveconfig_b1c2b9"
},
{
"name": "ServeConfig",
"description": "This configuration is for the model serve module.",
"link": "./config_serveconfig_7a0577"
},
{
"name": "ServeConfig",
"description": "This configuration is for the prompt serve module.",
"link": "./config_serveconfig_854dad"
},
{
"name": "ServeConfig",
"description": "This configuration is for the RAG serve module.",
"link": "./config_serveconfig_7889f9"
},
]} />
---
title: "ServiceConfig Configuration"
description: "ServiceConfig(web: dbgpt_app.config.ServiceWebParameters = <factory>, model: dbgpt.model.parameter.ModelServiceConfig = <factory>)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServiceConfig",
"description": "ServiceConfig(web: dbgpt_app.config.ServiceWebParameters = <factory>, model: dbgpt.model.parameter.ModelServiceConfig = <factory>)",
"documentationUrl": "",
"parameters": [
{
"name": "web",
"type": "ServiceWebParameters",
"required": false,
"description": "Web service configuration",
"nestedTypes": [
{
"type": "link",
"text": "servicewebparameters configuration",
"url": "config_servicewebparameters_3ab7fd"
}
],
"defaultValue": "ServiceWebParameters"
},
{
"name": "model",
"type": "ModelServiceConfig",
"required": false,
"description": "Model service configuration",
"nestedTypes": [
{
"type": "link",
"text": "modelserviceconfig configuration",
"url": "parameter_modelserviceconfig_20d67d"
}
],
"defaultValue": "ModelServiceConfig"
}
]
}} />
---
title: "ServiceWebParameters Configuration"
description: "ServiceWebParameters(host: str = '0.0.0.0', port: int = 5670, light: Optional[bool] = False, controller_addr: Optional[str] = None, database: dbgpt.datasource.parameter.BaseDatasourceParameters = <factory>, model_storage: Optional[str] = None, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, log: Optional[dbgpt.util.utils.LoggingParameters] = None, disable_alembic_upgrade: Optional[bool] = False, db_ssl_verify: Optional[bool] = False, default_thread_pool_size: Optional[int] = None, remote_embedding: Optional[bool] = False, remote_rerank: Optional[bool] = False, awel_dirs: Optional[str] = None, new_web_ui: bool = True, model_cache: dbgpt.storage.cache.manager.ModelCacheParameters = <factory>, embedding_model_max_seq_len: Optional[int] = 512)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServiceWebParameters",
"description": "ServiceWebParameters(host: str = '0.0.0.0', port: int = 5670, light: Optional[bool] = False, controller_addr: Optional[str] = None, database: dbgpt.datasource.parameter.BaseDatasourceParameters = <factory>, model_storage: Optional[str] = None, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, log: Optional[dbgpt.util.utils.LoggingParameters] = None, disable_alembic_upgrade: Optional[bool] = False, db_ssl_verify: Optional[bool] = False, default_thread_pool_size: Optional[int] = None, remote_embedding: Optional[bool] = False, remote_rerank: Optional[bool] = False, awel_dirs: Optional[str] = None, new_web_ui: bool = True, model_cache: dbgpt.storage.cache.manager.ModelCacheParameters = <factory>, embedding_model_max_seq_len: Optional[int] = 512)",
"documentationUrl": "",
"parameters": [
{
"name": "host",
"type": "string",
"required": false,
"description": "Webserver deploy host",
"defaultValue": "0.0.0.0"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "Webserver deploy port, default is 5670",
"defaultValue": "5670"
},
{
"name": "light",
"type": "boolean",
"required": false,
"description": "Run Webserver in light mode",
"defaultValue": "False"
},
{
"name": "controller_addr",
"type": "string",
"required": false,
"description": "The Model controller address to connect. If None, read model controller address from environment key `MODEL_SERVER`."
},
{
"name": "database",
"type": "BaseDatasourceParameters",
"required": false,
"description": "Database connection config, now support SQLite, OceanBase and MySQL",
"nestedTypes": [
{
"type": "link",
"text": "rdbmsdatasourceparameters configuration",
"url": "../datasource/base_rdbmsdatasourceparameters_4f774f"
},
{
"type": "link",
"text": "sqlite configuration",
"url": "../datasource/conn_sqlite_sqliteconnectorparameters_82c8b5"
},
{
"type": "link",
"text": "tugraph configuration",
"url": "../datasource/conn_tugraph_tugraphparameters_0c844e"
},
{
"type": "link",
"text": "spark configuration",
"url": "../datasource/conn_spark_sparkparameters_174bbc"
},
{
"type": "link",
"text": "clickhouse configuration",
"url": "../datasource/conn_clickhouse_clickhouseparameters_4a1237"
},
{
"type": "link",
"text": "doris configuration",
"url": "../datasource/conn_doris_dorisparameters_e33c53"
},
{
"type": "link",
"text": "duckdb configuration",
"url": "../datasource/conn_duckdb_duckdbconnectorparameters_c672c7"
},
{
"type": "link",
"text": "hive configuration",
"url": "../datasource/conn_hive_hiveparameters_ec3601"
},
{
"type": "link",
"text": "mssql configuration",
"url": "../datasource/conn_mssql_mssqlparameters_d79d1c"
},
{
"type": "link",
"text": "mysql configuration",
"url": "../datasource/conn_mysql_mysqlparameters_4393c4"
},
{
"type": "link",
"text": "oceanbase configuration",
"url": "../datasource/conn_oceanbase_oceanbaseparameters_260d2d"
},
{
"type": "link",
"text": "postgresql configuration",
"url": "../datasource/conn_postgresql_postgresqlparameters_22efa5"
},
{
"type": "link",
"text": "starrocks configuration",
"url": "../datasource/conn_starrocks_starrocksparameters_e511f7"
},
{
"type": "link",
"text": "vertica configuration",
"url": "../datasource/conn_vertica_verticaparameters_c712b8"
}
],
"defaultValue": "SQLiteConnectorParameters"
},
{
"name": "model_storage",
"type": "string",
"required": false,
"description": "The storage type of model configures, if None, use the default storage(current database). When you run in light mode, it will not use any storage.",
"validValues": [
"database",
"memory"
]
},
{
"name": "trace",
"type": "TracerParameters",
"required": false,
"description": "Tracer config for web server, if None, use global tracer config",
"nestedTypes": [
{
"type": "link",
"text": "tracerparameters configuration",
"url": "../utils/tracer_impl_tracerparameters_f8f272"
}
]
},
{
"name": "log",
"type": "LoggingParameters",
"required": false,
"description": "Logging configuration for web server, if None, use global config",
"nestedTypes": [
{
"type": "link",
"text": "loggingparameters configuration",
"url": "../utils/utils_loggingparameters_4ba5c6"
}
]
},
{
"name": "disable_alembic_upgrade",
"type": "boolean",
"required": false,
"description": "Whether to disable alembic to initialize and upgrade database metadata",
"defaultValue": "False"
},
{
"name": "db_ssl_verify",
"type": "boolean",
"required": false,
"description": "Whether to verify the SSL certificate of the database",
"defaultValue": "False"
},
{
"name": "default_thread_pool_size",
"type": "integer",
"required": false,
"description": "The default thread pool size, If None, use default config of python thread pool"
},
{
"name": "remote_embedding",
"type": "boolean",
"required": false,
"description": "Whether to enable remote embedding models. If it is True, you need to start a embedding model through `dbgpt start worker --worker_type text2vec --model_name xxx --model_path xxx`",
"defaultValue": "False"
},
{
"name": "remote_rerank",
"type": "boolean",
"required": false,
"description": "Whether to enable remote rerank models. If it is True, you need to start a rerank model through `dbgpt start worker --worker_type text2vec --rerank --model_name xxx --model_path xxx`",
"defaultValue": "False"
},
{
"name": "awel_dirs",
"type": "string",
"required": false,
"description": "The directories to search awel files, split by `,`"
},
{
"name": "new_web_ui",
"type": "boolean",
"required": false,
"description": "Whether to use the new web UI, default is True",
"defaultValue": "True"
},
{
"name": "model_cache",
"type": "ModelCacheParameters",
"required": false,
"description": "Model cache configuration",
"nestedTypes": [
{
"type": "link",
"text": "modelcacheparameters configuration",
"url": "../utils/manager_modelcacheparameters_152367"
}
],
"defaultValue": "ModelCacheParameters"
},
{
"name": "embedding_model_max_seq_len",
"type": "integer",
"required": false,
"description": "The max sequence length of the embedding model, default is 512",
"defaultValue": "512"
}
]
}} />
---
title: "service"
description: "service Configuration"
---
# service Configuration
This document provides an overview of all configuration classes in service type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "DBModelRegistryParameters",
"description": "Database model registry parameters.",
"link": "./parameter_dbmodelregistryparameters_87d036"
},
]} />
---
title: "DBModelRegistryParameters Configuration"
description: "Database model registry parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "DBModelRegistryParameters",
"description": "Database model registry parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "database",
"type": "BaseDatasourceParameters",
"required": false,
"description": "Database configuration for model registry",
"nestedTypes": [
{
"type": "link",
"text": "rdbmsdatasourceparameters configuration",
"url": "../datasource/base_rdbmsdatasourceparameters_4f774f"
},
{
"type": "link",
"text": "sqlite configuration",
"url": "../datasource/conn_sqlite_sqliteconnectorparameters_82c8b5"
},
{
"type": "link",
"text": "tugraph configuration",
"url": "../datasource/conn_tugraph_tugraphparameters_0c844e"
},
{
"type": "link",
"text": "spark configuration",
"url": "../datasource/conn_spark_sparkparameters_174bbc"
},
{
"type": "link",
"text": "clickhouse configuration",
"url": "../datasource/conn_clickhouse_clickhouseparameters_4a1237"
},
{
"type": "link",
"text": "doris configuration",
"url": "../datasource/conn_doris_dorisparameters_e33c53"
},
{
"type": "link",
"text": "duckdb configuration",
"url": "../datasource/conn_duckdb_duckdbconnectorparameters_c672c7"
},
{
"type": "link",
"text": "hive configuration",
"url": "../datasource/conn_hive_hiveparameters_ec3601"
},
{
"type": "link",
"text": "mssql configuration",
"url": "../datasource/conn_mssql_mssqlparameters_d79d1c"
},
{
"type": "link",
"text": "mysql configuration",
"url": "../datasource/conn_mysql_mysqlparameters_4393c4"
},
{
"type": "link",
"text": "oceanbase configuration",
"url": "../datasource/conn_oceanbase_oceanbaseparameters_260d2d"
},
{
"type": "link",
"text": "postgresql configuration",
"url": "../datasource/conn_postgresql_postgresqlparameters_22efa5"
},
{
"type": "link",
"text": "starrocks configuration",
"url": "../datasource/conn_starrocks_starrocksparameters_e511f7"
},
{
"type": "link",
"text": "vertica configuration",
"url": "../datasource/conn_vertica_verticaparameters_c712b8"
}
]
}
]
}} />
---
title: "ModelAPIServerParameters Configuration"
description: "ModelAPIServerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8100, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, controller_addr: Optional[str] = 'http://127.0.0.1:8000', api_keys: Optional[str] = None, embedding_batch_size: Optional[int] = None, ignore_stop_exceeds_error: Optional[bool] = False)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelAPIServerParameters",
"description": "ModelAPIServerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8100, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, controller_addr: Optional[str] = 'http://127.0.0.1:8000', api_keys: Optional[str] = None, embedding_batch_size: Optional[int] = None, ignore_stop_exceeds_error: Optional[bool] = False)",
"documentationUrl": "",
"parameters": [
{
"name": "host",
"type": "string",
"required": false,
"description": "The host IP address to bind to.",
"defaultValue": "0.0.0.0"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "Model API server deploy port",
"defaultValue": "8100"
},
{
"name": "daemon",
"type": "boolean",
"required": false,
"description": "Run the server as a daemon.",
"defaultValue": "False"
},
{
"name": "log",
"type": "LoggingParameters",
"required": false,
"description": "Logging configuration",
"nestedTypes": [
{
"type": "link",
"text": "loggingparameters configuration",
"url": "../utils/utils_loggingparameters_4ba5c6"
}
],
"defaultValue": "LoggingParameters"
},
{
"name": "trace",
"type": "TracerParameters",
"required": false,
"description": "Tracer configuration",
"nestedTypes": [
{
"type": "link",
"text": "tracerparameters configuration",
"url": "../utils/tracer_impl_tracerparameters_f8f272"
}
]
},
{
"name": "controller_addr",
"type": "string",
"required": false,
"description": "The Model controller address to connect",
"defaultValue": "http://127.0.0.1:8000"
},
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "Optional list of comma separated API keys"
},
{
"name": "embedding_batch_size",
"type": "integer",
"required": false,
"description": "Embedding batch size"
},
{
"name": "ignore_stop_exceeds_error",
"type": "boolean",
"required": false,
"description": "Ignore exceeds stop words error",
"defaultValue": "False"
}
]
}} />
---
title: "ModelControllerParameters Configuration"
description: "ModelControllerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8000, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, registry: Optional[dbgpt.model.parameter.BaseModelRegistryParameters] = None, heartbeat_interval_secs: Optional[int] = 20, heartbeat_timeout_secs: Optional[int] = 60)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelControllerParameters",
"description": "ModelControllerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8000, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, registry: Optional[dbgpt.model.parameter.BaseModelRegistryParameters] = None, heartbeat_interval_secs: Optional[int] = 20, heartbeat_timeout_secs: Optional[int] = 60)",
"documentationUrl": "",
"parameters": [
{
"name": "host",
"type": "string",
"required": false,
"description": "The host IP address to bind to.",
"defaultValue": "0.0.0.0"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "Model Controller deploy port",
"defaultValue": "8000"
},
{
"name": "daemon",
"type": "boolean",
"required": false,
"description": "Run the server as a daemon.",
"defaultValue": "False"
},
{
"name": "log",
"type": "LoggingParameters",
"required": false,
"description": "Logging configuration",
"nestedTypes": [
{
"type": "link",
"text": "loggingparameters configuration",
"url": "../utils/utils_loggingparameters_4ba5c6"
}
],
"defaultValue": "LoggingParameters"
},
{
"name": "trace",
"type": "TracerParameters",
"required": false,
"description": "Tracer configuration",
"nestedTypes": [
{
"type": "link",
"text": "tracerparameters configuration",
"url": "../utils/tracer_impl_tracerparameters_f8f272"
}
]
},
{
"name": "registry",
"type": "BaseModelRegistryParameters",
"required": false,
"description": "Model registry configuration. If None, use embedded registry",
"nestedTypes": [
{
"type": "link",
"text": "___model_registry_placeholder___ configuration",
"url": "parameter_dbmodelregistryparameters_87d036"
}
]
},
{
"name": "heartbeat_interval_secs",
"type": "integer",
"required": false,
"description": "The interval for checking heartbeats (seconds)",
"defaultValue": "20"
},
{
"name": "heartbeat_timeout_secs",
"type": "integer",
"required": false,
"description": "The timeout for checking heartbeats (seconds), it will be set unhealthy if the worker is not responding in this time",
"defaultValue": "60"
}
]
}} />
---
title: "ModelsDeployParameters Configuration"
description: "ModelsDeployParameters(default_llm: Optional[str] = None, default_embedding: Optional[str] = None, default_reranker: Optional[str] = None, llms: List[dbgpt.core.interface.parameter.LLMDeployModelParameters] = <factory>, embeddings: List[dbgpt.core.interface.parameter.EmbeddingDeployModelParameters] = <factory>, rerankers: List[dbgpt.core.interface.parameter.RerankerDeployModelParameters] = <factory>)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelsDeployParameters",
"description": "ModelsDeployParameters(default_llm: Optional[str] = None, default_embedding: Optional[str] = None, default_reranker: Optional[str] = None, llms: List[dbgpt.core.interface.parameter.LLMDeployModelParameters] = <factory>, embeddings: List[dbgpt.core.interface.parameter.EmbeddingDeployModelParameters] = <factory>, rerankers: List[dbgpt.core.interface.parameter.RerankerDeployModelParameters] = <factory>)",
"documentationUrl": "",
"parameters": [
{
"name": "default_llm",
"type": "string",
"required": false,
"description": "Default LLM model name, used to specify which model to use when you have multiple LLMs"
},
{
"name": "default_embedding",
"type": "string",
"required": false,
"description": "Default embedding model name, used to specify which model to use when you have multiple embedding models"
},
{
"name": "default_reranker",
"type": "string",
"required": false,
"description": "Default reranker model name, used to specify which model to use when you have multiple reranker models"
},
{
"name": "llms",
"type": "LLMDeployModelParameters",
"required": false,
"description": "LLM model deploy configuration. If you deploy in cluster mode, you just deploy one model.",
"nestedTypes": [
{
"type": "link",
"text": "hf configuration",
"url": "../llm/hf_adapter_hfllmdeploymodelparameters_103e81"
},
{
"type": "link",
"text": "vllm configuration",
"url": "../llm/vllm_adapter_vllmdeploymodelparameters_1d4a24"
},
{
"type": "link",
"text": "llama.cpp.server configuration",
"url": "../llm/llama_cpp_adapter_llamaserverparameters_421f40"
},
{
"type": "link",
"text": "llama.cpp configuration",
"url": "../llm/llama_cpp_py_adapter_llamacppmodelparameters_e88874"
},
{
"type": "link",
"text": "proxy/openai configuration",
"url": "../llm/chatgpt_openaicompatibledeploymodelparameters_c3d426"
},
{
"type": "link",
"text": "proxy/siliconflow configuration",
"url": "../llm/siliconflow_siliconflowdeploymodelparameters_abe22f"
},
{
"type": "link",
"text": "proxy/zhipu configuration",
"url": "../llm/zhipu_zhipudeploymodelparameters_c51e31"
},
{
"type": "link",
"text": "proxy/moonshot configuration",
"url": "../llm/moonshot_moonshotdeploymodelparameters_aa2f6b"
},
{
"type": "link",
"text": "proxy/gitee configuration",
"url": "../llm/gitee_giteedeploymodelparameters_d1bdb3"
},
{
"type": "link",
"text": "proxy/deepseek configuration",
"url": "../llm/deepseek_deepseekdeploymodelparameters_194cbd"
},
{
"type": "link",
"text": "proxy/ollama configuration",
"url": "../llm/ollama_ollamadeploymodelparameters_d55be6"
},
{
"type": "link",
"text": "proxy/yi configuration",
"url": "../llm/yi_yideploymodelparameters_92dbaa"
},
{
"type": "link",
"text": "proxy/spark configuration",
"url": "../llm/spark_sparkdeploymodelparameters_afba3c"
},
{
"type": "link",
"text": "proxy/baichuan configuration",
"url": "../llm/baichuan_baichuandeploymodelparameters_0bf9cc"
},
{
"type": "link",
"text": "proxy/gemini configuration",
"url": "../llm/gemini_geminideploymodelparameters_5113b9"
},
{
"type": "link",
"text": "proxy/tongyi configuration",
"url": "../llm/tongyi_tongyideploymodelparameters_02a91b"
},
{
"type": "link",
"text": "proxy/volcengine configuration",
"url": "../llm/volcengine_volcenginedeploymodelparameters_938015"
},
{
"type": "link",
"text": "proxy/wenxin configuration",
"url": "../llm/wenxin_wenxindeploymodelparameters_63c66b"
},
{
"type": "link",
"text": "proxy/claude configuration",
"url": "../llm/claude_claudedeploymodelparameters_1f0c45"
}
],
"defaultValue": "[]"
},
{
"name": "embeddings",
"type": "EmbeddingDeployModelParameters",
"required": false,
"description": "Embedding model deploy configuration. If you deploy in cluster mode, you just deploy one model.",
"nestedTypes": [
{
"type": "link",
"text": "hf configuration",
"url": "../embedding/embeddings_hfembeddingdeploymodelparameters_f588e1"
},
{
"type": "link",
"text": "proxy/openai configuration",
"url": "../embedding/embeddings_openapiembeddingdeploymodelparameters_f9ba47"
},
{
"type": "link",
"text": "proxy/jina configuration",
"url": "../embedding/jina_jinaembeddingsdeploymodelparameters_40b0f2"
},
{
"type": "link",
"text": "proxy/ollama configuration",
"url": "../embedding/ollama_ollamaembeddingdeploymodelparameters_b511e0"
},
{
"type": "link",
"text": "proxy/qianfan configuration",
"url": "../embedding/qianfan_qianfanembeddingdeploymodelparameters_257d2a"
},
{
"type": "link",
"text": "proxy/tongyi configuration",
"url": "../embedding/tongyi_tongyiembeddingdeploymodelparameters_a7cbb4"
}
],
"defaultValue": "[]"
},
{
"name": "rerankers",
"type": "RerankerDeployModelParameters",
"required": false,
"description": "Reranker model deploy configuration. If you deploy in cluster mode, you just deploy one model.",
"nestedTypes": [
{
"type": "link",
"text": "hf configuration",
"url": "../reranker/rerank_crossencoderrerankembeddingsparameters_63ec13"
},
{
"type": "link",
"text": "proxy/openapi configuration",
"url": "../reranker/rerank_openapirerankerdeploymodelparameters_778108"
},
{
"type": "link",
"text": "proxy/siliconflow configuration",
"url": "../reranker/rerank_siliconflowrerankembeddingsparameters_af0257"
}
],
"defaultValue": "[]"
}
]
}} />
---
title: "ModelServiceConfig Configuration"
description: "Model service configuration."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelServiceConfig",
"description": "Model service configuration.",
"documentationUrl": "",
"parameters": [
{
"name": "worker",
"type": "ModelWorkerParameters",
"required": false,
"description": "Model worker configuration",
"nestedTypes": [
{
"type": "link",
"text": "modelworkerparameters configuration",
"url": "parameter_modelworkerparameters_3fd00b"
}
],
"defaultValue": "ModelWorkerParameters"
},
{
"name": "api",
"type": "ModelAPIServerParameters",
"required": false,
"description": "Model API",
"nestedTypes": [
{
"type": "link",
"text": "modelapiserverparameters configuration",
"url": "parameter_modelapiserverparameters_763bec"
}
],
"defaultValue": "ModelControllerParameters"
},
{
"name": "controller",
"type": "ModelControllerParameters",
"required": false,
"description": "Model controller",
"nestedTypes": [
{
"type": "link",
"text": "modelcontrollerparameters configuration",
"url": "parameter_modelcontrollerparameters_689309"
}
],
"defaultValue": "ModelControllerParameters"
}
]
}} />
---
title: "ModelWorkerParameters Configuration"
description: "ModelWorkerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8001, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, worker_type: Optional[str] = None, worker_class: Optional[str] = None, standalone: Optional[bool] = False, register: Optional[bool] = True, worker_register_host: Optional[str] = None, controller_addr: Optional[str] = None, send_heartbeat: Optional[bool] = True, heartbeat_interval: Optional[int] = 20)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelWorkerParameters",
"description": "ModelWorkerParameters(host: Optional[str] = '0.0.0.0', port: Optional[int] = 8001, daemon: Optional[bool] = False, log: dbgpt.util.utils.LoggingParameters = <factory>, trace: Optional[dbgpt.util.tracer.tracer_impl.TracerParameters] = None, worker_type: Optional[str] = None, worker_class: Optional[str] = None, standalone: Optional[bool] = False, register: Optional[bool] = True, worker_register_host: Optional[str] = None, controller_addr: Optional[str] = None, send_heartbeat: Optional[bool] = True, heartbeat_interval: Optional[int] = 20)",
"documentationUrl": "",
"parameters": [
{
"name": "host",
"type": "string",
"required": false,
"description": "The host IP address to bind to.",
"defaultValue": "0.0.0.0"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "Model worker deploy port",
"defaultValue": "8001"
},
{
"name": "daemon",
"type": "boolean",
"required": false,
"description": "Run the server as a daemon.",
"defaultValue": "False"
},
{
"name": "log",
"type": "LoggingParameters",
"required": false,
"description": "Logging configuration",
"nestedTypes": [
{
"type": "link",
"text": "loggingparameters configuration",
"url": "../utils/utils_loggingparameters_4ba5c6"
}
],
"defaultValue": "LoggingParameters"
},
{
"name": "trace",
"type": "TracerParameters",
"required": false,
"description": "Tracer configuration",
"nestedTypes": [
{
"type": "link",
"text": "tracerparameters configuration",
"url": "../utils/tracer_impl_tracerparameters_f8f272"
}
]
},
{
"name": "worker_type",
"type": "string",
"required": false,
"description": "Worker type",
"validValues": [
"llm",
"text2vec",
"reranker"
]
},
{
"name": "worker_class",
"type": "string",
"required": false,
"description": "Model worker class, dbgpt.model.cluster.DefaultModelWorker"
},
{
"name": "standalone",
"type": "boolean",
"required": false,
"description": "Standalone mode. If True, embedded Run ModelController",
"defaultValue": "False"
},
{
"name": "register",
"type": "boolean",
"required": false,
"description": "Register current worker to model controller",
"defaultValue": "True"
},
{
"name": "worker_register_host",
"type": "string",
"required": false,
"description": "The ip address of current worker to register to ModelController. If None, the address is automatically determined"
},
{
"name": "controller_addr",
"type": "string",
"required": false,
"description": "The Model controller address to register"
},
{
"name": "send_heartbeat",
"type": "boolean",
"required": false,
"description": "Send heartbeat to model controller",
"defaultValue": "True"
},
{
"name": "heartbeat_interval",
"type": "integer",
"required": false,
"description": "The interval for sending heartbeats (seconds)",
"defaultValue": "20"
}
]
}} />
---
title: "OSSStorageConfig Configuration"
description: "OSSStorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "OSSStorageConfig",
"description": "OSSStorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576)",
"documentationUrl": "",
"parameters": [
{
"name": "endpoint",
"type": "string",
"required": true,
"description": "The endpoint of the OSS server. e.g. https://oss-cn-hangzhou.aliyuncs.com"
},
{
"name": "region",
"type": "string",
"required": true,
"description": "The region of the OSS server. e.g. cn-hangzhou"
},
{
"name": "access_key_id",
"type": "string",
"required": false,
"description": "The access key ID of the OSS server. You can also set it in the environment variable OSS_ACCESS_KEY_ID"
},
{
"name": "access_key_secret",
"type": "string",
"required": false,
"description": "The access key secret of the OSS server. You can also set it in the environment variable OSS_ACCESS_KEY_SECRET"
},
{
"name": "use_environment_credentials",
"type": "boolean",
"required": false,
"description": "Whether to use the environment variables OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET as the credentials. Default is False.",
"defaultValue": "False"
},
{
"name": "fixed_bucket",
"type": "string",
"required": false,
"description": "The fixed bucket name to use. If set, all logical buckets in DB-GPT will be mapped to this bucket. We suggest you set this value to avoid bucket name conflicts."
},
{
"name": "bucket_prefix",
"type": "string",
"required": false,
"description": "The prefix of the bucket name. If set, all logical buckets in DB-GPT will be prefixed with this value. Just work when fixed_bucket is None.",
"defaultValue": "dbgpt-fs-"
},
{
"name": "auto_create_bucket",
"type": "boolean",
"required": false,
"description": "Whether to create the bucket automatically if it does not exist. If set to False, the bucket must exist before using it.",
"defaultValue": "True"
},
{
"name": "save_chunk_size",
"type": "integer",
"required": false,
"description": "The chunk size when saving the file. When the file is larger 10x than this value, it will be uploaded in multiple parts. Default is 1M.",
"defaultValue": "1048576"
}
]
}} />
---
title: "S3StorageConfig Configuration"
description: "S3StorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576, signature_version: Optional[str] = None, s3_config: Optional[Dict[str, Any]] = <factory>)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "S3StorageConfig",
"description": "S3StorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576, signature_version: Optional[str] = None, s3_config: Optional[Dict[str, Any]] = <factory>)",
"documentationUrl": "",
"parameters": [
{
"name": "endpoint",
"type": "string",
"required": true,
"description": "The endpoint of the s3 server. e.g. https://s3.us-east-1.amazonaws.com"
},
{
"name": "region",
"type": "string",
"required": true,
"description": "The region of the s3 server. e.g. us-east-1"
},
{
"name": "access_key_id",
"type": "string",
"required": false,
"description": "The access key ID of the s3 server. You can also set it in the environment variable AWS_ACCESS_KEY_ID"
},
{
"name": "access_key_secret",
"type": "string",
"required": false,
"description": "The access key secret of the s3 server. You can also set it in the environment variable AWS_SECRET_ACCESS_KEY"
},
{
"name": "use_environment_credentials",
"type": "boolean",
"required": false,
"description": "Whether to use the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as the credentials. Default is False.",
"defaultValue": "False"
},
{
"name": "fixed_bucket",
"type": "string",
"required": false,
"description": "The fixed bucket name to use. If set, all logical buckets in DB-GPT will be mapped to this bucket. We suggest you set this value to avoid bucket name conflicts."
},
{
"name": "bucket_prefix",
"type": "string",
"required": false,
"description": "The prefix of the bucket name. If set, all logical buckets in DB-GPT will be prefixed with this value. Just work when fixed_bucket is None.",
"defaultValue": "dbgpt-fs-"
},
{
"name": "auto_create_bucket",
"type": "boolean",
"required": false,
"description": "Whether to create the bucket automatically if it does not exist. If set to False, the bucket must exist before using it.",
"defaultValue": "True"
},
{
"name": "save_chunk_size",
"type": "integer",
"required": false,
"description": "The chunk size when saving the file. When the file is larger 10x than this value, it will be uploaded in multiple parts. Default is 1M.",
"defaultValue": "1048576"
},
{
"name": "signature_version",
"type": "string",
"required": false,
"description": "The signature version of the s3 server. e.g. s3v4, s3v2, None (default)"
},
{
"name": "s3_config",
"type": "object",
"required": false,
"description": "The additional configuration for the S3 client.",
"defaultValue": "{}"
}
]
}} />
---
title: "utils"
description: "utils Configuration"
---
# utils Configuration
This document provides an overview of all configuration classes in utils type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "OSSStorageConfig",
"description": "OSSStorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576)",
"link": "./config_ossstorageconfig_1ad505"
},
{
"name": "S3StorageConfig",
"description": "S3StorageConfig(endpoint: str, region: str, access_key_id: Optional[str] = None, access_key_secret: Optional[str] = None, use_environment_credentials: Optional[bool] = False, fixed_bucket: Optional[str] = None, bucket_prefix: Optional[str] = 'dbgpt-fs-', auto_create_bucket: Optional[bool] = True, save_chunk_size: Optional[int] = 1048576, signature_version: Optional[str] = None, s3_config: Optional[Dict[str, Any]] = <factory>)",
"link": "./config_s3storageconfig_f0cdc9"
},
]} />
---
title: "ModelCacheParameters Configuration"
description: "Model cache configuration."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ModelCacheParameters",
"description": "Model cache configuration.",
"documentationUrl": "",
"parameters": [
{
"name": "enable_model_cache",
"type": "boolean",
"required": false,
"description": "Whether to enable model cache, default is True",
"defaultValue": "True"
},
{
"name": "storage_type",
"type": "string",
"required": false,
"description": "The storage type, default is memory",
"defaultValue": "memory"
},
{
"name": "max_memory_mb",
"type": "integer",
"required": false,
"description": "The max memory in MB, default is 256",
"defaultValue": "256"
},
{
"name": "persist_dir",
"type": "string",
"required": false,
"description": "The persist directory, default is model_cache",
"defaultValue": "model_cache"
}
]
}} />
---
title: "TracerParameters Configuration"
description: "TracerParameters(file: Optional[str] = None, root_operation_name: Optional[str] = None, exporter: Optional[str] = None, otlp_endpoint: Optional[str] = None, otlp_insecure: Optional[bool] = None, otlp_timeout: Optional[int] = None, tracer_storage_cls: Optional[str] = None)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "TracerParameters",
"description": "TracerParameters(file: Optional[str] = None, root_operation_name: Optional[str] = None, exporter: Optional[str] = None, otlp_endpoint: Optional[str] = None, otlp_insecure: Optional[bool] = None, otlp_timeout: Optional[int] = None, tracer_storage_cls: Optional[str] = None)",
"documentationUrl": "",
"parameters": [
{
"name": "file",
"type": "string",
"required": false,
"description": "The file to store the tracer, e.g. dbgpt_webserver_tracer.jsonl"
},
{
"name": "root_operation_name",
"type": "string",
"required": false,
"description": "The root operation name of the tracer"
},
{
"name": "exporter",
"type": "string",
"required": false,
"description": "The exporter of the tracer, e.g. telemetry"
},
{
"name": "otlp_endpoint",
"type": "string",
"required": false,
"description": "The endpoint of the OpenTelemetry Protocol, you can set '${env:OTEL_EXPORTER_OTLP_TRACES_ENDPOINT}' to use the environment variable"
},
{
"name": "otlp_insecure",
"type": "boolean",
"required": false,
"description": "Whether to use insecure connection, you can set '${env:OTEL_EXPORTER_OTLP_TRACES_INSECURE}' to use the environment "
},
{
"name": "otlp_timeout",
"type": "integer",
"required": false,
"description": "The timeout of the connection, in seconds, you can set '${env:OTEL_EXPORTER_OTLP_TRACES_TIMEOUT}' to use the environment "
},
{
"name": "tracer_storage_cls",
"type": "string",
"required": false,
"description": "The class of the tracer storage"
}
]
}} />
---
title: "LoggingParameters Configuration"
description: "Logging parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "LoggingParameters",
"description": "Logging parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "level",
"type": "string",
"required": false,
"description": "Logging level, just support FATAL, ERROR, WARNING, INFO, DEBUG, NOTSET",
"defaultValue": "${env:DBGPT_LOG_LEVEL:-INFO}",
"validValues": [
"FATAL",
"ERROR",
"WARNING",
"WARNING",
"INFO",
"DEBUG",
"NOTSET"
]
},
{
"name": "file",
"type": "string",
"required": false,
"description": "The filename to store logs"
}
]
}} />
---
title: "Chroma Config Configuration"
description: "Chroma vector store config."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChromaVectorConfig",
"description": "Chroma vector store config.",
"documentationUrl": null,
"parameters": [
{
"name": "user",
"type": "string",
"required": false,
"description": "The user of vector store, if not set, will use the default user."
},
{
"name": "password",
"type": "string",
"required": false,
"description": "The password of vector store, if not set, will use the default password."
},
{
"name": "persist_path",
"type": "string",
"required": false,
"description": "The persist path of vector store."
},
{
"name": "collection_metadata",
"type": "object",
"required": false,
"description": "The metadata of collection."
}
]
}} />
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment