Commit 396700dd authored by chenzk's avatar chenzk
Browse files

v1.0

parents
Pipeline #2603 failed with stages
in 0 seconds
---
title: "Zhipu Proxy LLM Configuration"
description: "Zhipu proxy LLM configuration."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ZhipuDeployModelParameters",
"description": "Zhipu proxy LLM configuration.",
"documentationUrl": "https://open.bigmodel.cn/dev/api/normal-model/glm-4#overview",
"parameters": [
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the model."
},
{
"name": "backend",
"type": "string",
"required": false,
"description": "The real model name to pass to the provider, default is None. If backend is None, use name as the real model name."
},
{
"name": "provider",
"type": "string",
"required": false,
"description": "The provider of the model. If model is deployed in local, this is the inference type. If model is deployed in third-party service, this is platform name('proxy/<platform>')",
"defaultValue": "proxy/zhipu"
},
{
"name": "verbose",
"type": "boolean",
"required": false,
"description": "Show verbose output.",
"defaultValue": "False"
},
{
"name": "concurrency",
"type": "integer",
"required": false,
"description": "Model concurrency limit",
"defaultValue": "100"
},
{
"name": "prompt_template",
"type": "string",
"required": false,
"description": "Prompt template. If None, the prompt template is automatically determined from model. Just for local deployment."
},
{
"name": "context_length",
"type": "integer",
"required": false,
"description": "The context length of the OpenAI API. If None, it is determined by the model."
},
{
"name": "reasoning_model",
"type": "boolean",
"required": false,
"description": "Whether the model is a reasoning model. If None, it is automatically determined from model."
},
{
"name": "api_base",
"type": "string",
"required": false,
"description": "The base url of the Zhipu API.",
"defaultValue": "${env:ZHIPUAI_BASE_URL:-https://open.bigmodel.cn/api/paas/v4}"
},
{
"name": "api_key",
"type": "string",
"required": false,
"description": "The API key of the Zhipu API.",
"defaultValue": "${env:ZHIPUAI_API_KEY}"
},
{
"name": "api_type",
"type": "string",
"required": false,
"description": "The type of the OpenAI API, if you use Azure, it can be: azure"
},
{
"name": "api_version",
"type": "string",
"required": false,
"description": "The version of the OpenAI API."
},
{
"name": "http_proxy",
"type": "string",
"required": false,
"description": "The http or https proxy to use openai"
}
]
}} />
---
title: "HookConfig Configuration"
description: "Hook configuration.
You can define a hook configuration with a path and optional parameters.
It will be used to dynamically load and execute a hook function or a callable
object."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "HookConfig",
"description": "Hook configuration.\n\n You can define a hook configuration with a path and optional parameters.\n It will be used to dynamically load and execute a hook function or a callable\n object.",
"documentationUrl": "",
"parameters": [
{
"name": "path",
"type": "string",
"required": true,
"description": "Hook path, it can be a class path or a function path. eg: 'dbgpt.config.hooks.env_var_hook'"
},
{
"name": "init_params",
"type": "object",
"required": false,
"description": "Hook init params to pass to the hook constructor(Just for class hook), must be key-value pairs",
"defaultValue": "{}"
},
{
"name": "params",
"type": "object",
"required": false,
"description": "Hook params to pass to the hook, must be key-value pairs",
"defaultValue": "{}"
},
{
"name": "enabled",
"type": "boolean",
"required": false,
"description": "Whether the hook is enabled, default is True",
"defaultValue": "True"
}
]
}} />
---
title: "BufferWindowGPTsAppMemoryConfig Configuration"
description: "Buffer window memory configuration.
This configuration is used to control the buffer window memory."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "BufferWindowGPTsAppMemoryConfig",
"description": "Buffer window memory configuration.\n\n This configuration is used to control the buffer window memory.",
"documentationUrl": "",
"parameters": [
{
"name": "keep_start_rounds",
"type": "integer",
"required": false,
"description": "The number of start rounds to keep in memory",
"defaultValue": "0"
},
{
"name": "keep_end_rounds",
"type": "integer",
"required": false,
"description": "The number of end rounds to keep in memory",
"defaultValue": "0"
}
]
}} />
---
title: "TokenBufferGPTsAppMemoryConfig Configuration"
description: "Token buffer memory configuration.
This configuration is used to control the token buffer memory."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "TokenBufferGPTsAppMemoryConfig",
"description": "Token buffer memory configuration.\n\n This configuration is used to control the token buffer memory.",
"documentationUrl": "",
"parameters": [
{
"name": "max_token_limit",
"type": "integer",
"required": false,
"description": "The max token limit. Default is 100k",
"defaultValue": "102400"
}
]
}} />
---
title: "memory"
description: "memory Configuration"
---
# memory Configuration
This document provides an overview of all configuration classes in memory type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "BufferWindowGPTsAppMemoryConfig",
"description": "Buffer window memory configuration.\n\n This configuration is used to control the buffer window memory.",
"link": "./config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"name": "TokenBufferGPTsAppMemoryConfig",
"description": "Token buffer memory configuration.\n\n This configuration is used to control the token buffer memory.",
"link": "./config_tokenbuffergptsappmemoryconfig_6a2000"
},
]} />
---
title: "Configuration Overview"
---
# Configuration Overview
This document provides an overview of all configuration classes organized by type.
## Configuration Types
- [app](#type-app) (6 classes)
- [datasource](#type-datasource) (14 classes)
- [embedding](#type-embedding) (6 classes)
- [graph_store](#type-graph_store) (4 classes)
- [llm](#type-llm) (22 classes)
- [memory](#type-memory) (2 classes)
- [other](#type-other) (1 classes)
- [reranker](#type-reranker) (3 classes)
- [serve](#type-serve) (13 classes)
- [service](#type-service) (1 classes)
- [utils](#type-utils) (2 classes)
- [vector_store](#type-vector_store) (6 classes)
## Type Details
### app {#type-app}
This type contains 6 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [ChatDashboardConfig](app/config_chatdashboardconfig_2480d0) | |
| [ChatExcelConfig](app/config_chatexcelconfig_8dcf86) | |
| [ChatKnowledgeConfig](app/config_chatknowledgeconfig_d51d9e) | |
| [ChatNormalConfig](app/config_chatnormalconfig_83c865) | |
| [ChatWithDBExecuteConfig](app/config_chatwithdbexecuteconfig_64fe0f) | |
| [ChatWithDBQAConfig](app/config_chatwithdbqaconfig_62cbe4) | |
---
### datasource {#type-datasource}
This type contains 14 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [ClickhouseParameters](datasource/conn_clickhouse_clickhouseparameters_4a1237) | |
| [DorisParameters](datasource/conn_doris_dorisparameters_e33c53) | |
| [DuckDbConnectorParameters](datasource/conn_duckdb_duckdbconnectorparameters_c672c7) | |
| [HiveParameters](datasource/conn_hive_hiveparameters_ec3601) | |
| [MSSQLParameters](datasource/conn_mssql_mssqlparameters_d79d1c) | |
| [MySQLParameters](datasource/conn_mysql_mysqlparameters_4393c4) | |
| [OceanBaseParameters](datasource/conn_oceanbase_oceanbaseparameters_260d2d) | |
| [PostgreSQLParameters](datasource/conn_postgresql_postgresqlparameters_22efa5) | |
| [RDBMSDatasourceParameters](datasource/base_rdbmsdatasourceparameters_4f774f) | |
| [SQLiteConnectorParameters](datasource/conn_sqlite_sqliteconnectorparameters_82c8b5) | |
| [SparkParameters](datasource/conn_spark_sparkparameters_174bbc) | |
| [StarRocksParameters](datasource/conn_starrocks_starrocksparameters_e511f7) | |
| [TuGraphParameters](datasource/conn_tugraph_tugraphparameters_0c844e) | |
| [VerticaParameters](datasource/conn_vertica_verticaparameters_c712b8) | |
---
### embedding {#type-embedding}
This type contains 6 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [HFEmbeddingDeployModelParameters](embedding/embeddings_hfembeddingdeploymodelparameters_f588e1) | |
| [JinaEmbeddingsDeployModelParameters](embedding/jina_jinaembeddingsdeploymodelparameters_40b0f2) | |
| [OllamaEmbeddingDeployModelParameters](embedding/ollama_ollamaembeddingdeploymodelparameters_b511e0) | |
| [OpenAPIEmbeddingDeployModelParameters](embedding/embeddings_openapiembeddingdeploymodelparameters_f9ba47) | |
| [QianfanEmbeddingDeployModelParameters](embedding/qianfan_qianfanembeddingdeploymodelparameters_257d2a) | |
| [TongyiEmbeddingDeployModelParameters](embedding/tongyi_tongyiembeddingdeploymodelparameters_a7cbb4) | |
---
### graph_store {#type-graph_store}
This type contains 4 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [BuiltinKnowledgeGraphConfig](graph_store/knowledge_graph_builtinknowledgegraphconfig_f26e05) | |
| [Neo4jStoreConfig](graph_store/neo4j_store_neo4jstoreconfig_a4db5d) | |
| [OpenSPGConfig](graph_store/open_spg_openspgconfig_a744fd) | |
| [TuGraphStoreConfig](graph_store/tugraph_store_tugraphstoreconfig_7ca8a8) | |
---
### llm {#type-llm}
This type contains 22 configuration classes.
#### Relationships
```mermaid
graph TD
HFLLMDeployModelParameters -->|quantization| BitsandbytesQuantization
HFLLMDeployModelParameters -->|quantization| BitsandbytesQuantization8bits
HFLLMDeployModelParameters -->|quantization| BitsandbytesQuantization4bits
```
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [BaichuanDeployModelParameters](llm/baichuan_baichuandeploymodelparameters_0bf9cc) | |
| [BitsandbytesQuantization](llm/parameter_bitsandbytesquantization_d40e3b) | |
| [BitsandbytesQuantization4bits](llm/parameter_bitsandbytesquantization4bits_52b778) | |
| [BitsandbytesQuantization8bits](llm/parameter_bitsandbytesquantization8bits_909aed) | |
| [ClaudeDeployModelParameters](llm/claude_claudedeploymodelparameters_1f0c45) | |
| [DeepSeekDeployModelParameters](llm/deepseek_deepseekdeploymodelparameters_194cbd) | |
| [GeminiDeployModelParameters](llm/gemini_geminideploymodelparameters_5113b9) | |
| [GiteeDeployModelParameters](llm/gitee_giteedeploymodelparameters_d1bdb3) | |
| [HFLLMDeployModelParameters](llm/hf_adapter_hfllmdeploymodelparameters_103e81) | |
| [LlamaCppModelParameters](llm/llama_cpp_py_adapter_llamacppmodelparameters_e88874) | |
| [LlamaServerParameters](llm/llama_cpp_adapter_llamaserverparameters_421f40) | |
| [MoonshotDeployModelParameters](llm/moonshot_moonshotdeploymodelparameters_aa2f6b) | |
| [OllamaDeployModelParameters](llm/ollama_ollamadeploymodelparameters_d55be6) | |
| [OpenAICompatibleDeployModelParameters](llm/chatgpt_openaicompatibledeploymodelparameters_c3d426) | |
| [SiliconFlowDeployModelParameters](llm/siliconflow_siliconflowdeploymodelparameters_abe22f) | |
| [SparkDeployModelParameters](llm/spark_sparkdeploymodelparameters_afba3c) | |
| [TongyiDeployModelParameters](llm/tongyi_tongyideploymodelparameters_02a91b) | |
| [VLLMDeployModelParameters](llm/vllm_adapter_vllmdeploymodelparameters_1d4a24) | |
| [VolcengineDeployModelParameters](llm/volcengine_volcenginedeploymodelparameters_938015) | |
| [WenxinDeployModelParameters](llm/wenxin_wenxindeploymodelparameters_63c66b) | |
| [YiDeployModelParameters](llm/yi_yideploymodelparameters_92dbaa) | |
| [ZhipuDeployModelParameters](llm/zhipu_zhipudeploymodelparameters_c51e31) | |
---
### memory {#type-memory}
This type contains 2 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [BufferWindowGPTsAppMemoryConfig](memory/config_bufferwindowgptsappmemoryconfig_c31071) | |
| [TokenBufferGPTsAppMemoryConfig](memory/config_tokenbuffergptsappmemoryconfig_6a2000) | |
---
### other {#type-other}
This type contains 1 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [ApplicationConfig](config_applicationconfig_72fd1c) | |
---
### reranker {#type-reranker}
This type contains 3 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [CrossEncoderRerankEmbeddingsParameters](reranker/rerank_crossencoderrerankembeddingsparameters_63ec13) | |
| [OpenAPIRerankerDeployModelParameters](reranker/rerank_openapirerankerdeploymodelparameters_778108) | |
| [SiliconFlowRerankEmbeddingsParameters](reranker/rerank_siliconflowrerankembeddingsparameters_af0257) | |
---
### serve {#type-serve}
This type contains 13 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [ServeConfig](serve/config_serveconfig_63f1e9) | |
| [ServeConfig](serve/config_serveconfig_adbd6f) | |
| [ServeConfig](serve/config_serveconfig_313252) | |
| [ServeConfig](serve/config_serveconfig_ec2d70) | |
| [ServeConfig](serve/config_serveconfig_1a9284) | |
| [ServeConfig](serve/config_serveconfig_8839e0) | |
| [ServeConfig](serve/config_serveconfig_fa1f35) | |
| [ServeConfig](serve/config_serveconfig_cb64c6) | |
| [ServeConfig](serve/config_serveconfig_c0b589) | |
| [ServeConfig](serve/config_serveconfig_b1c2b9) | |
| [ServeConfig](serve/config_serveconfig_7a0577) | |
| [ServeConfig](serve/config_serveconfig_854dad) | |
| [ServeConfig](serve/config_serveconfig_7889f9) | |
---
### service {#type-service}
This type contains 1 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [DBModelRegistryParameters](service/parameter_dbmodelregistryparameters_87d036) | |
---
### utils {#type-utils}
This type contains 2 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [OSSStorageConfig](utils/config_ossstorageconfig_1ad505) | |
| [S3StorageConfig](utils/config_s3storageconfig_f0cdc9) | |
---
### vector_store {#type-vector_store}
This type contains 6 configuration classes.
#### Configuration Classes
| Class | Description |
|-------|-------------|
| [ChromaVectorConfig](vector_store/chroma_store_chromavectorconfig_16224f) | |
| [ElasticsearchStoreConfig](vector_store/elastic_store_elasticsearchstoreconfig_15bdb6) | |
| [MilvusVectorConfig](vector_store/milvus_store_milvusvectorconfig_20af52) | |
| [OceanBaseConfig](vector_store/oceanbase_store_oceanbaseconfig_220e36) | |
| [PGVectorConfig](vector_store/pgvector_store_pgvectorconfig_3ef448) | |
| [WeaviateVectorConfig](vector_store/weaviate_store_weaviatevectorconfig_093ce3) | |
---
## Cross-Type Relationships
The following diagram shows relationships between different configuration types:
```mermaid
graph TD
other[other - 1 classes]
datasource[datasource - 14 classes]
llm[llm - 22 classes]
embedding[embedding - 6 classes]
reranker[reranker - 3 classes]
service[service - 1 classes]
graph_store[graph_store - 4 classes]
vector_store[vector_store - 6 classes]
serve[serve - 13 classes]
memory[memory - 2 classes]
app[app - 6 classes]
utils[utils - 2 classes]
service -->|14 connections| datasource
other -->|13 connections| serve
serve -->|2 connections| utils
app -->|14 connections| memory
```
## Looking for a specific configuration?
1. Use the search function in the documentation site
2. Browse the configuration types above
3. Check the specific class documentation for detailed parameter information
---
title: "reranker"
description: "reranker Configuration"
---
# reranker Configuration
This document provides an overview of all configuration classes in reranker type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "CrossEncoderRerankEmbeddingsParameters",
"description": "CrossEncoder Rerank Embeddings Parameters.",
"link": "./rerank_crossencoderrerankembeddingsparameters_63ec13"
},
{
"name": "OpenAPIRerankerDeployModelParameters",
"description": "OpenAPI Reranker Deploy Model Parameters.",
"link": "./rerank_openapirerankerdeploymodelparameters_778108"
},
{
"name": "SiliconFlowRerankEmbeddingsParameters",
"description": "SiliconFlow Rerank Embeddings Parameters.",
"link": "./rerank_siliconflowrerankembeddingsparameters_af0257"
},
]} />
---
title: "CrossEncoderRerankEmbeddingsParameters Configuration"
description: "CrossEncoder Rerank Embeddings Parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "CrossEncoderRerankEmbeddingsParameters",
"description": "CrossEncoder Rerank Embeddings Parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the model."
},
{
"name": "path",
"type": "string",
"required": false,
"description": "The path of the model, if you want to deploy a local model."
},
{
"name": "device",
"type": "string",
"required": false,
"description": "Device to run model. If None, the device is automatically determined"
},
{
"name": "provider",
"type": "string",
"required": false,
"description": "The provider of the model. If model is deployed in local, this is the inference type. If model is deployed in third-party service, this is platform name('proxy/<platform>')",
"defaultValue": "hf"
},
{
"name": "verbose",
"type": "boolean",
"required": false,
"description": "Show verbose output.",
"defaultValue": "False"
},
{
"name": "concurrency",
"type": "integer",
"required": false,
"description": "Model concurrency limit",
"defaultValue": "50"
},
{
"name": "max_length",
"type": "integer",
"required": false,
"description": "Max length for input sequences. Longer sequences will be truncated."
},
{
"name": "model_kwargs",
"type": "object",
"required": false,
"description": "Keyword arguments to pass to the model.",
"defaultValue": "{}"
}
]
}} />
---
title: "OpenAPIRerankerDeployModelParameters Configuration"
description: "OpenAPI Reranker Deploy Model Parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "OpenAPIRerankerDeployModelParameters",
"description": "OpenAPI Reranker Deploy Model Parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the model."
},
{
"name": "provider",
"type": "string",
"required": false,
"description": "The provider of the model. If model is deployed in local, this is the inference type. If model is deployed in third-party service, this is platform name('proxy/<platform>')",
"defaultValue": "proxy/openapi"
},
{
"name": "verbose",
"type": "boolean",
"required": false,
"description": "Show verbose output.",
"defaultValue": "False"
},
{
"name": "concurrency",
"type": "integer",
"required": false,
"description": "Model concurrency limit",
"defaultValue": "50"
},
{
"name": "api_url",
"type": "string",
"required": false,
"description": "The URL of the rerank API.",
"defaultValue": "http://localhost:8100/v1/beta/relevance"
},
{
"name": "api_key",
"type": "string",
"required": false,
"description": "The API key for the rerank API."
},
{
"name": "backend",
"type": "string",
"required": false,
"description": "The real model name to pass to the provider, default is None. If backend is None, use name as the real model name."
},
{
"name": "timeout",
"type": "integer",
"required": false,
"description": "The timeout for the request in seconds.",
"defaultValue": "60"
}
]
}} />
---
title: "SiliconFlowRerankEmbeddingsParameters Configuration"
description: "SiliconFlow Rerank Embeddings Parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "SiliconFlowRerankEmbeddingsParameters",
"description": "SiliconFlow Rerank Embeddings Parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "name",
"type": "string",
"required": true,
"description": "The name of the model."
},
{
"name": "provider",
"type": "string",
"required": false,
"description": "The provider of the model. If model is deployed in local, this is the inference type. If model is deployed in third-party service, this is platform name('proxy/<platform>')",
"defaultValue": "proxy/siliconflow"
},
{
"name": "verbose",
"type": "boolean",
"required": false,
"description": "Show verbose output.",
"defaultValue": "False"
},
{
"name": "concurrency",
"type": "integer",
"required": false,
"description": "Model concurrency limit",
"defaultValue": "50"
},
{
"name": "api_url",
"type": "string",
"required": false,
"description": "The URL of the rerank API.",
"defaultValue": "https://api.siliconflow.cn/v1/rerank"
},
{
"name": "api_key",
"type": "string",
"required": false,
"description": "The API key for the rerank API.",
"defaultValue": "${env:SILICONFLOW_API_KEY}"
},
{
"name": "backend",
"type": "string",
"required": false,
"description": "The real model name to pass to the provider, default is None. If backend is None, use name as the real model name."
},
{
"name": "timeout",
"type": "integer",
"required": false,
"description": "The timeout for the request in seconds.",
"defaultValue": "60"
}
]
}} />
---
title: "My dbgpts Serve Configurations Configuration"
description: "This configuration is for the my dbgpts serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the my dbgpts serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "Conversation Serve Configurations Configuration"
description: "This configuration is for the conversation serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the conversation serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "default_model",
"type": "string",
"required": false,
"description": "Default model for the conversation"
}
]
}} />
---
title: "Datasource Serve Configurations Configuration"
description: "This configuration is for the datasource serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the datasource serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "RAG Serve Configurations Configuration"
description: "This configuration is for the RAG serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the RAG serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "embedding_model",
"type": "string",
"required": false,
"description": "Embedding Model",
"defaultValue": "None"
},
{
"name": "rerank_model",
"type": "string",
"required": false,
"description": "Embedding Model",
"defaultValue": "None"
},
{
"name": "chunk_size",
"type": "integer",
"required": false,
"description": "Whether to verify the SSL certificate of the database",
"defaultValue": "500"
},
{
"name": "chunk_overlap",
"type": "integer",
"required": false,
"description": "The default thread pool size, If None, use default config of python thread pool",
"defaultValue": "50"
},
{
"name": "similarity_top_k",
"type": "integer",
"required": false,
"description": "knowledge search top k",
"defaultValue": "10"
},
{
"name": "similarity_score_threshold",
"type": "integer",
"required": false,
"description": "knowledge search top similarity score",
"defaultValue": "0.0"
},
{
"name": "query_rewrite",
"type": "boolean",
"required": false,
"description": "knowledge search rewrite",
"defaultValue": "False"
},
{
"name": "max_chunks_once_load",
"type": "integer",
"required": false,
"description": "knowledge max chunks once load",
"defaultValue": "10"
},
{
"name": "max_threads",
"type": "integer",
"required": false,
"description": "knowledge max load thread",
"defaultValue": "1"
},
{
"name": "rerank_top_k",
"type": "integer",
"required": false,
"description": "knowledge rerank top k",
"defaultValue": "3"
}
]
}} />
---
title: "Model Serve Configurations Configuration"
description: "This configuration is for the model serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the model serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"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"
]
}
]
}} />
---
title: "Prompt Serve Configurations Configuration"
description: "This configuration is for the prompt serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the prompt serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "default_user",
"type": "string",
"required": false,
"description": "Default user name for prompt"
},
{
"name": "default_sys_code",
"type": "string",
"required": false,
"description": "Default system code for prompt"
}
]
}} />
---
title: "Evaluate Serve Configurations Configuration"
description: "This configuration is for the evaluate serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the evaluate serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "embedding_model",
"type": "string",
"required": false,
"description": "Embedding Model",
"defaultValue": "None"
},
{
"name": "similarity_top_k",
"type": "integer",
"required": false,
"description": "knowledge search top k",
"defaultValue": "10"
}
]
}} />
---
title: "ServeConfig Configuration"
description: "Parameters for the serve command"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "Parameters for the serve command",
"documentationUrl": "",
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "Libro Serve Configurations Configuration"
description: "This configuration is for the libro serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the libro serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
}
]
}} />
---
title: "AWEL Flow Serve Configurations Configuration"
description: "This configuration is for the flow serve module."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ServeConfig",
"description": "This configuration is for the flow serve module.",
"documentationUrl": null,
"parameters": [
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys for the endpoint, if None, allow all"
},
{
"name": "load_dbgpts_interval",
"type": "integer",
"required": false,
"description": "Interval to load dbgpts from installed packages",
"defaultValue": "5"
},
{
"name": "encrypt_key",
"type": "string",
"required": false,
"description": "The key to encrypt the data"
}
]
}} />
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