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

v1.0

parents
Pipeline #2603 failed with stages
in 0 seconds
# DB-GPT V0.6.0, Defining new standards for AI-native data applications.
## Introduction
DB-GPT is an open source AI native data application development framework with AWEL and agents. In the V0.6.0 version, we further provide flexible and scalable AI native data application management and development capabilities around large models, which can help enterprises quickly build and deploy intelligent AI data applications, and achieve enterprise digital transformation and business growth through intelligent data analysis, insights and decisions
### The V0.6.0 version mainly adds and enhances the following core features
- AWEL protocol upgrade 2.0, supporting more complex orchestration
- Supports the creation and lifecycle management of data applications, and supports multiple application construction modes, such as: multi-agent automatic planning mode, task flow orchestration mode, single agent mode, and native application mode
- GraphRAG supports graph community summary and hybrid retrieval, and the graph index cost is reduced by 50% compared to Microsoft GraphRAG.
- Supports multiple Agent Memories, such as perceptual memory, short-term memory, long-term memory, hybrid memory, etc.
- Supports intent recognition and prompt management, and newly added support for Text2NLU and Text2GQL fine-tuning
- GPT-Vis front-end visualization upgrade to support richer visualization charts
<p align="center">
<img src={'/img/app/app_chat_v0.6.jpg'} width="800px" />
</p>
## Features
**AWEL protocol upgrade 2.0 supports more complex orchestration and optimizes front-end visualization and interaction capabilities.**
AWEL (Agentic Workflow Expression Language) is an agent-based workflow expression language designed specifically for large model application development, providing powerful functions and flexibility. Through the AWEL API, developers can focus on large model application logic development without having to pay attention to cumbersome model, environment and other details. In AWEL2.0, we support more complex orchestration and visualization
<p align="center">
<img src={'/img/app/agent_prompt_awel_v0.6.jpg'} width="800px" />
</p>
**Supports the creation and life cycle management of data applications, and supports multiple modes to build applications, such as: multi-agent automatic planning mode, task flow orchestration mode, single agent mode, and native application mode**
<p align="center">
<img src={'/img/app/app_manage_mode_v0.6.jpg'} width="800px" />
</p>
<p align="center">
<img src={'/img/app/app_manage_app_v0.6.jpg'} width="800px" />
</p>
**GraphRAG supports graph community summarization and hybrid retrieval.**
The graph construction and retrieval performance have obvious advantages compared to community solutions, and it supports cool visualization. GraphRAG is an enhanced retrieval generation system based on knowledge graphs. Through the construction and retrieval of knowledge graphs, it further enhances the accuracy of retrieval and the stability of recall, while reducing the illusion of large models and enhancing the effects of domain applications. DB-GPT combines with TuGraph to build efficient retrieval enhancement generation capabilities
<p align="center">
<img src={'/img/app/graph_rag_pipeline_v0.6.png'} width="800px" />
</p>
Based on the universal RAG framework launched in DB-GPT version 0.5.6 that integrates vector index, graph index, and full-text index, DB-GPT version 0.6.0 has enhanced the capabilities of graph index (GraphRAG) to support graph community summary and hybrid retrieval. ability. In the new version, we introduced TuGraph’s built-in Leiden community discovery algorithm, combined with large models to extract community subgraph summaries, and finally used similarity recall of community summaries to cope with generalized questioning scenarios, namely QFS (Query Focused Summarization). question. In addition, in the knowledge extraction stage, we upgraded the original triple extraction to graph extraction with point edge information summary, and optimized cross-text block associated information extraction through text block history to further enhance the information density of the knowledge graph.
Based on the above design, we used the open source knowledge graph corpus (OSGraph) provided by the TuGraph community and the product introduction materials of DB-GPT and TuGraph (about 43k tokens in total), and conducted comparative tests with Microsoft's GraphRAG system. Finally, DB-GPT It only consumes 50% of the token overhead and generates a knowledge graph of the same scale. And on the premise that the quality of the question and answer test is equivalent, the global search performance has been significantly improved.
<p align="center">
<img src={'/img/app/graph_rag_v0.6.png'} width="800px" />
</p>
For the final generated knowledge graph, we used AntV's G6 engine to upgrade the front-end rendering logic, which can intuitively preview the knowledge graph data and community segmentation results.
<p align="center">
<img src={'/img/app/graph_rag_display_v0.6.png'} width="800px" />
</p>
**GPT-Vis: GPT-Vis is an interactive visualization solution for LLM and data, supporting rich visual chart display and intelligent recommendations**
<p align="center">
<img src={'/img/app/app_chat_v0.6.jpg'} width="800px" />
</p>
**Text2GQL and Text2NLU fine-tuning: Newly supports fine-tuning from natural language to graph language, as well as fine-tuning for semantic classification.**
<p align="center">
<img src={'/img/ft/ft_pipeline.jpg'} width="800px" />
</p>
## How to Upgrade?
[Upgrade to v0.6.0](../upgrade/v0.6.0.md)
## User Manual
- [Apps](../application/apps/app_manage.md)
- [AWEL](../awel/awel.md)
- [GraphRAG](../application/graph_rag.md)
## Acknowledgements
This iteration is inseparable from the participation of developers and users in the community, and it also further cooperates with the [TuGraph](https://github.com/TuGraph-family) and [AntV](https://github.com/antvis) communities. Thanks to all the contributors who made this release possible!
@Aries-ckt, @Dreammy23, @Hec-gitHub, @JxQg, @KingSkyLi, @M1n9X, @bigcash, @chaplinthink, @csunny, @dusens, @fangyinc, @huangjh131, @hustcc, @lhwan, @whyuds and @yhjun1026
## Reference
- [中文手册](https://www.yuque.com/eosphoros/dbgpt-docs/ym574wh2hddunfbd)
\ No newline at end of file
# ChangeLog
Our version release information is maintained on GitHub. For more details, please visit [ReleaseNotes](https://github.com/eosphoros-ai/DB-GPT/releases)
---
title: "ChatDashboardConfig Configuration"
description: "Chat Dashboard Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatDashboardConfig",
"description": "Chat Dashboard Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "The memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
]
},
{
"name": "schema_retrieve_top_k",
"type": "integer",
"required": false,
"description": "The number of tables to retrieve from the database.",
"defaultValue": "10"
},
{
"name": "schema_max_tokens",
"type": "integer",
"required": false,
"description": "The maximum number of tokens to pass to the model, default 100 * 1024.Just work for the schema retrieval failed, and load all tables schema.",
"defaultValue": "102400"
}
]
}} />
---
title: "ChatExcelConfig Configuration"
description: "Chat Excel Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatExcelConfig",
"description": "Chat Excel Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "Memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
],
"defaultValue": "BufferWindowGPTsAppMemoryConfig"
},
{
"name": "duckdb_extensions_dir",
"type": "string",
"required": false,
"description": "The directory of the duckdb extensions.Duckdb will download the extensions from the internet if not provided.This configuration is used to tell duckdb where to find the extensions and avoid downloading. Note that the extensions are platform-specific and version-specific.",
"defaultValue": "[]"
},
{
"name": "force_install",
"type": "boolean",
"required": false,
"description": "Whether to force install the duckdb extensions. If True, the extensions will be installed even if they are already installed.",
"defaultValue": "False"
}
]
}} />
---
title: "ChatKnowledgeConfig Configuration"
description: "Chat Knowledge Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatKnowledgeConfig",
"description": "Chat Knowledge Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "Memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
],
"defaultValue": "BufferWindowGPTsAppMemoryConfig"
},
{
"name": "knowledge_retrieve_top_k",
"type": "integer",
"required": false,
"description": "The number of chunks to retrieve from the knowledge space.",
"defaultValue": "10"
},
{
"name": "knowledge_retrieve_rerank_top_k",
"type": "integer",
"required": false,
"description": "The number of chunks after reranking.",
"defaultValue": "10"
},
{
"name": "similarity_score_threshold",
"type": "number",
"required": false,
"description": "The minimum similarity score to return from the query.",
"defaultValue": "0.0"
}
]
}} />
---
title: "ChatNormalConfig Configuration"
description: "Chat Normal Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatNormalConfig",
"description": "Chat Normal Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "Memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
],
"defaultValue": "TokenBufferGPTsAppMemoryConfig"
}
]
}} />
---
title: "ChatWithDBExecuteConfig Configuration"
description: "Chat With DB Execute Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatWithDBExecuteConfig",
"description": "Chat With DB Execute Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "Memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
],
"defaultValue": "BufferWindowGPTsAppMemoryConfig"
},
{
"name": "schema_retrieve_top_k",
"type": "integer",
"required": false,
"description": "The number of tables to retrieve from the database.",
"defaultValue": "10"
},
{
"name": "schema_max_tokens",
"type": "integer",
"required": false,
"description": "The maximum number of tokens to pass to the model, default 100 * 1024.Just work for the schema retrieval failed, and load all tables schema.",
"defaultValue": "102400"
},
{
"name": "max_num_results",
"type": "integer",
"required": false,
"description": "The maximum number of results to return from the query.",
"defaultValue": "50"
}
]
}} />
---
title: "ChatWithDBQAConfig Configuration"
description: "Chat With DB QA Configuration"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ChatWithDBQAConfig",
"description": "Chat With DB QA Configuration",
"documentationUrl": "",
"parameters": [
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "Memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
],
"defaultValue": "BufferWindowGPTsAppMemoryConfig"
},
{
"name": "schema_retrieve_top_k",
"type": "integer",
"required": false,
"description": "The number of tables to retrieve from the database.",
"defaultValue": "10"
},
{
"name": "schema_max_tokens",
"type": "integer",
"required": false,
"description": "The maximum number of tokens to pass to the model, default 100 * 1024.Just work for the schema retrieval failed, and load all tables schema.",
"defaultValue": "102400"
},
{
"name": "max_num_results",
"type": "integer",
"required": false,
"description": "The maximum number of results to return from the query.",
"defaultValue": "50"
}
]
}} />
---
title: "GPTsAppConfig Configuration"
description: "GPTs application configuration.
For global configuration, you can set the parameters here."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "GPTsAppConfig",
"description": "GPTs application configuration.\n\n For global configuration, you can set the parameters here.",
"documentationUrl": "",
"parameters": [
{
"name": "name",
"type": "string",
"required": false,
"description": "The name of your app"
},
{
"name": "top_k",
"type": "integer",
"required": false,
"description": "The top k for LLM generation"
},
{
"name": "top_p",
"type": "number",
"required": false,
"description": "The top p for LLM generation"
},
{
"name": "temperature",
"type": "number",
"required": false,
"description": "The temperature for LLM generation"
},
{
"name": "max_new_tokens",
"type": "integer",
"required": false,
"description": "The max new tokens for LLM generation"
},
{
"name": "memory",
"type": "BaseGPTsAppMemoryConfig",
"required": false,
"description": "The memory configuration",
"nestedTypes": [
{
"type": "link",
"text": "window configuration",
"url": "../memory/config_bufferwindowgptsappmemoryconfig_c31071"
},
{
"type": "link",
"text": "token configuration",
"url": "../memory/config_tokenbuffergptsappmemoryconfig_6a2000"
}
]
},
{
"name": "configs",
"type": "GPTsAppCommonConfig",
"required": false,
"description": "The configs for specific app",
"nestedTypes": [
{
"type": "link",
"text": "chat_knowledge configuration",
"url": "config_chatknowledgeconfig_d51d9e"
},
{
"type": "link",
"text": "chat_with_db_qa configuration",
"url": "config_chatwithdbqaconfig_62cbe4"
},
{
"type": "link",
"text": "chat_with_db_execute configuration",
"url": "config_chatwithdbexecuteconfig_64fe0f"
},
{
"type": "link",
"text": "chat_normal configuration",
"url": "config_chatnormalconfig_83c865"
},
{
"type": "link",
"text": "chat_excel configuration",
"url": "config_chatexcelconfig_8dcf86"
},
{
"type": "link",
"text": "chat_dashboard configuration",
"url": "config_chatdashboardconfig_2480d0"
}
],
"defaultValue": "[]"
}
]
}} />
---
title: "RagParameters Configuration"
description: "Rag configuration."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "RagParameters",
"description": "Rag configuration.",
"documentationUrl": "",
"parameters": [
{
"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": "number",
"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"
},
{
"name": "storage",
"type": "StorageConfig",
"required": false,
"description": "Storage configuration",
"nestedTypes": [
{
"type": "link",
"text": "storageconfig configuration",
"url": "config_storageconfig_028579"
}
],
"defaultValue": "StorageConfig"
},
{
"name": "knowledge_graph_chunk_search_top_k",
"type": "integer",
"required": false,
"description": "knowledge graph search top k",
"defaultValue": "5"
},
{
"name": "kg_enable_summary",
"type": "boolean",
"required": false,
"description": "graph community summary enabled",
"defaultValue": "False"
},
{
"name": "llm_model",
"type": "string",
"required": false,
"description": "kg extract llm model"
},
{
"name": "kg_extract_top_k",
"type": "integer",
"required": false,
"description": "kg extract top k",
"defaultValue": "5"
},
{
"name": "kg_extract_score_threshold",
"type": "number",
"required": false,
"description": "kg extract score threshold",
"defaultValue": "0.3"
},
{
"name": "kg_community_top_k",
"type": "integer",
"required": false,
"description": "kg community top k",
"defaultValue": "50"
},
{
"name": "kg_community_score_threshold",
"type": "number",
"required": false,
"description": "kg_community_score_threshold",
"defaultValue": "0.3"
},
{
"name": "kg_triplet_graph_enabled",
"type": "boolean",
"required": false,
"description": "kg_triplet_graph_enabled",
"defaultValue": "True"
},
{
"name": "kg_document_graph_enabled",
"type": "boolean",
"required": false,
"description": "kg_document_graph_enabled",
"defaultValue": "True"
},
{
"name": "kg_chunk_search_top_k",
"type": "integer",
"required": false,
"description": "kg_chunk_search_top_k",
"defaultValue": "5"
},
{
"name": "kg_extraction_batch_size",
"type": "integer",
"required": false,
"description": "kg_extraction_batch_size",
"defaultValue": "3"
},
{
"name": "kg_community_summary_batch_size",
"type": "integer",
"required": false,
"description": "kg_community_summary_batch_size",
"defaultValue": "20"
},
{
"name": "kg_embedding_batch_size",
"type": "integer",
"required": false,
"description": "kg_embedding_batch_size",
"defaultValue": "20"
},
{
"name": "kg_similarity_top_k",
"type": "integer",
"required": false,
"description": "kg_similarity_top_k",
"defaultValue": "5"
},
{
"name": "kg_similarity_score_threshold",
"type": "number",
"required": false,
"description": "kg_similarity_score_threshold",
"defaultValue": "0.7"
},
{
"name": "kg_enable_text_search",
"type": "boolean",
"required": false,
"description": "kg_enable_text_search",
"defaultValue": "False"
},
{
"name": "kg_text2gql_model_enabled",
"type": "boolean",
"required": false,
"description": "kg_text2gql_model_enabled",
"defaultValue": "False"
},
{
"name": "kg_text2gql_model_name",
"type": "string",
"required": false,
"description": "text2gql_model_name"
},
{
"name": "bm25_k1",
"type": "number",
"required": false,
"description": "bm25_k1",
"defaultValue": "2.0"
},
{
"name": "bm25_b",
"type": "number",
"required": false,
"description": "bm25_b",
"defaultValue": "0.75"
}
]
}} />
---
title: "StorageConfig Configuration"
description: "StorageConfig(vector: Optional[dbgpt_ext.storage.vector_store.chroma_store.ChromaVectorConfig] = <factory>, graph: Optional[dbgpt_ext.storage.graph_store.tugraph_store.TuGraphStoreConfig] = None, full_text: Optional[dbgpt_ext.storage.vector_store.elastic_store.ElasticsearchStoreConfig] = None)"
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "StorageConfig",
"description": "StorageConfig(vector: Optional[dbgpt_ext.storage.vector_store.chroma_store.ChromaVectorConfig] = <factory>, graph: Optional[dbgpt_ext.storage.graph_store.tugraph_store.TuGraphStoreConfig] = None, full_text: Optional[dbgpt_ext.storage.vector_store.elastic_store.ElasticsearchStoreConfig] = None)",
"documentationUrl": "",
"parameters": [
{
"name": "vector",
"type": "ChromaVectorConfig",
"required": false,
"description": "default vector type",
"nestedTypes": [
{
"type": "link",
"text": "chroma configuration",
"url": "../vector_store/chroma_store_chromavectorconfig_16224f"
},
{
"type": "link",
"text": "elasticsearch configuration",
"url": "../vector_store/elastic_store_elasticsearchstoreconfig_15bdb6"
},
{
"type": "link",
"text": "pgvector configuration",
"url": "../vector_store/pgvector_store_pgvectorconfig_3ef448"
},
{
"type": "link",
"text": "weaviate configuration",
"url": "../vector_store/weaviate_store_weaviatevectorconfig_093ce3"
},
{
"type": "link",
"text": "milvus configuration",
"url": "../vector_store/milvus_store_milvusvectorconfig_20af52"
},
{
"type": "link",
"text": "oceanbase configuration",
"url": "../vector_store/oceanbase_store_oceanbaseconfig_220e36"
}
],
"defaultValue": "ChromaVectorConfig"
},
{
"name": "graph",
"type": "TuGraphStoreConfig",
"required": false,
"description": "default graph type",
"nestedTypes": [
{
"type": "link",
"text": "tugraph configuration",
"url": "../graph_store/tugraph_store_tugraphstoreconfig_7ca8a8"
}
]
},
{
"name": "full_text",
"type": "ElasticsearchStoreConfig",
"required": false,
"description": "default full text type",
"nestedTypes": [
{
"type": "link",
"text": "chroma configuration",
"url": "../vector_store/chroma_store_chromavectorconfig_16224f"
},
{
"type": "link",
"text": "elasticsearch configuration",
"url": "../vector_store/elastic_store_elasticsearchstoreconfig_15bdb6"
},
{
"type": "link",
"text": "pgvector configuration",
"url": "../vector_store/pgvector_store_pgvectorconfig_3ef448"
},
{
"type": "link",
"text": "weaviate configuration",
"url": "../vector_store/weaviate_store_weaviatevectorconfig_093ce3"
},
{
"type": "link",
"text": "milvus configuration",
"url": "../vector_store/milvus_store_milvusvectorconfig_20af52"
},
{
"type": "link",
"text": "oceanbase configuration",
"url": "../vector_store/oceanbase_store_oceanbaseconfig_220e36"
}
]
}
]
}} />
---
title: "app"
description: "app Configuration"
---
# app Configuration
This document provides an overview of all configuration classes in app type.
import { ConfigClassTable } from '@site/src/components/mdx/ConfigClassTable';
## Configuration Classes
<ConfigClassTable classes={[
{
"name": "ChatDashboardConfig",
"description": "Chat Dashboard Configuration",
"link": "./config_chatdashboardconfig_2480d0"
},
{
"name": "ChatExcelConfig",
"description": "Chat Excel Configuration",
"link": "./config_chatexcelconfig_8dcf86"
},
{
"name": "ChatKnowledgeConfig",
"description": "Chat Knowledge Configuration",
"link": "./config_chatknowledgeconfig_d51d9e"
},
{
"name": "ChatNormalConfig",
"description": "Chat Normal Configuration",
"link": "./config_chatnormalconfig_83c865"
},
{
"name": "ChatWithDBExecuteConfig",
"description": "Chat With DB Execute Configuration",
"link": "./config_chatwithdbexecuteconfig_64fe0f"
},
{
"name": "ChatWithDBQAConfig",
"description": "Chat With DB QA Configuration",
"link": "./config_chatwithdbqaconfig_62cbe4"
},
]} />
---
title: "ApplicationConfig Configuration"
description: "Application configuration."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ApplicationConfig",
"description": "Application configuration.",
"documentationUrl": "",
"parameters": [
{
"name": "hooks",
"type": "HookConfig",
"required": false,
"description": "Configuration hooks, which will be executed before the configuration loading",
"nestedTypes": [
{
"type": "link",
"text": "hookconfig configuration",
"url": "manager_hookconfig_d9a481"
}
],
"defaultValue": "[]"
},
{
"name": "system",
"type": "SystemParameters",
"required": false,
"description": "System configuration",
"nestedTypes": [
{
"type": "link",
"text": "systemparameters configuration",
"url": "config_systemparameters_fd92b9"
}
],
"defaultValue": "SystemParameters"
},
{
"name": "service",
"type": "ServiceConfig",
"required": false,
"description": "",
"nestedTypes": [
{
"type": "link",
"text": "serviceconfig configuration",
"url": "service/config_serviceconfig_81a10f"
}
],
"defaultValue": "ServiceConfig"
},
{
"name": "models",
"type": "ModelsDeployParameters",
"required": false,
"description": "Model deployment configuration",
"nestedTypes": [
{
"type": "link",
"text": "modelsdeployparameters configuration",
"url": "service/parameter_modelsdeployparameters_5c7bc5"
}
],
"defaultValue": "ModelsDeployParameters"
},
{
"name": "serves",
"type": "BaseServeConfig",
"required": false,
"description": "Serve configuration",
"nestedTypes": [
{
"type": "link",
"text": "datasource configuration",
"url": "serve/config_serveconfig_63f1e9"
},
{
"type": "link",
"text": "agent/chat configuration",
"url": "serve/config_serveconfig_adbd6f"
},
{
"type": "link",
"text": "conversation configuration",
"url": "serve/config_serveconfig_313252"
},
{
"type": "link",
"text": "dbgpts_hub configuration",
"url": "serve/config_serveconfig_ec2d70"
},
{
"type": "link",
"text": "dbgpts_my configuration",
"url": "serve/config_serveconfig_1a9284"
},
{
"type": "link",
"text": "evaluate configuration",
"url": "serve/config_serveconfig_8839e0"
},
{
"type": "link",
"text": "feedback configuration",
"url": "serve/config_serveconfig_fa1f35"
},
{
"type": "link",
"text": "file configuration",
"url": "serve/config_serveconfig_cb64c6"
},
{
"type": "link",
"text": "flow configuration",
"url": "serve/config_serveconfig_c0b589"
},
{
"type": "link",
"text": "libro configuration",
"url": "serve/config_serveconfig_b1c2b9"
},
{
"type": "link",
"text": "model configuration",
"url": "serve/config_serveconfig_7a0577"
},
{
"type": "link",
"text": "prompt configuration",
"url": "serve/config_serveconfig_854dad"
},
{
"type": "link",
"text": "rag configuration",
"url": "serve/config_serveconfig_7889f9"
}
],
"defaultValue": "[]"
},
{
"name": "rag",
"type": "RagParameters",
"required": false,
"description": "Rag Knowledge Parameters",
"nestedTypes": [
{
"type": "link",
"text": "ragparameters configuration",
"url": "app/config_ragparameters_7483b2"
}
],
"defaultValue": "RagParameters"
},
{
"name": "app",
"type": "GPTsAppConfig",
"required": false,
"description": "GPTs application configuration",
"nestedTypes": [
{
"type": "link",
"text": "gptsappconfig configuration",
"url": "app/config_gptsappconfig_134d16"
}
],
"defaultValue": "GPTsAppConfig"
},
{
"name": "trace",
"type": "TracerParameters",
"required": false,
"description": "Global tracer configuration",
"nestedTypes": [
{
"type": "link",
"text": "tracerparameters configuration",
"url": "utils/tracer_impl_tracerparameters_f8f272"
}
],
"defaultValue": "TracerParameters"
},
{
"name": "log",
"type": "LoggingParameters",
"required": false,
"description": "Logging configuration",
"nestedTypes": [
{
"type": "link",
"text": "loggingparameters configuration",
"url": "utils/utils_loggingparameters_4ba5c6"
}
],
"defaultValue": "LoggingParameters"
}
]
}} />
---
title: "SystemParameters Configuration"
description: "System parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "SystemParameters",
"description": "System parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "language",
"type": "string",
"required": false,
"description": "Language setting",
"defaultValue": "en",
"validValues": [
"en",
"zh",
"fr",
"ja",
"ko",
"ru"
]
},
{
"name": "log_level",
"type": "string",
"required": false,
"description": "Logging level",
"defaultValue": "INFO",
"validValues": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
]
},
{
"name": "api_keys",
"type": "string",
"required": false,
"description": "API keys",
"defaultValue": "[]"
},
{
"name": "encrypt_key",
"type": "string",
"required": false,
"description": "The key to encrypt the data",
"defaultValue": "your_secret_key"
}
]
}} />
---
title: "RDBMSDatasourceParameters Configuration"
description: "RDBMS datasource parameters."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "RDBMSDatasourceParameters",
"description": "RDBMS datasource parameters.",
"documentationUrl": "",
"parameters": [
{
"name": "host",
"type": "string",
"required": true,
"description": "Database host, e.g., localhost"
},
{
"name": "port",
"type": "integer",
"required": true,
"description": "Database port, e.g., 3306"
},
{
"name": "user",
"type": "string",
"required": true,
"description": "Database user to connect"
},
{
"name": "database",
"type": "string",
"required": true,
"description": "Database name"
},
{
"name": "driver",
"type": "string",
"required": true,
"description": "Database driver, e.g., mysql+pymysql"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "Database password, you can write your password directly, of course, you can also use environment variables, such as ${env:DBGPT_DB_PASSWORD}",
"defaultValue": "${env:DBGPT_DB_PASSWORD}"
},
{
"name": "pool_size",
"type": "integer",
"required": false,
"description": "Connection pool size, default 5",
"defaultValue": "5"
},
{
"name": "max_overflow",
"type": "integer",
"required": false,
"description": "Max overflow connections, default 10",
"defaultValue": "10"
},
{
"name": "pool_timeout",
"type": "integer",
"required": false,
"description": "Connection pool timeout, default 30",
"defaultValue": "30"
},
{
"name": "pool_recycle",
"type": "integer",
"required": false,
"description": "Connection pool recycle, default 3600",
"defaultValue": "3600"
},
{
"name": "pool_pre_ping",
"type": "boolean",
"required": false,
"description": "Connection pool pre ping, default True",
"defaultValue": "True"
}
]
}} />
---
title: "Clickhouse datasource Configuration"
description: "Columnar database for high-performance analytics and real-time queries."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "ClickhouseParameters",
"description": "Columnar database for high-performance analytics and real-time queries.",
"documentationUrl": null,
"parameters": [
{
"name": "host",
"type": "string",
"required": true,
"description": "Database host, e.g., localhost"
},
{
"name": "port",
"type": "integer",
"required": true,
"description": "Database port, e.g., 8123"
},
{
"name": "user",
"type": "string",
"required": true,
"description": "Database user to connect"
},
{
"name": "database",
"type": "string",
"required": true,
"description": "Database name"
},
{
"name": "engine",
"type": "string",
"required": false,
"description": "Storage engine, e.g., MergeTree",
"defaultValue": "MergeTree"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "Database password, you can write your password directly, of course, you can also use environment variables, such as ${env:DBGPT_DB_PASSWORD}",
"defaultValue": "${env:DBGPT_DB_PASSWORD}"
},
{
"name": "http_pool_maxsize",
"type": "integer",
"required": false,
"description": "http pool maxsize",
"defaultValue": "16"
},
{
"name": "http_pool_num_pools",
"type": "integer",
"required": false,
"description": "http pool num_pools",
"defaultValue": "12"
},
{
"name": "connect_timeout",
"type": "integer",
"required": false,
"description": "Database connect timeout, default 15s",
"defaultValue": "15"
},
{
"name": "distributed_ddl_task_timeout",
"type": "integer",
"required": false,
"description": "Distributed ddl task timeout, default 300s",
"defaultValue": "300"
}
]
}} />
---
title: "Apache Doris datasource Configuration"
description: "A new-generation open-source real-time data warehouse."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "DorisParameters",
"description": "A new-generation open-source real-time data warehouse.",
"documentationUrl": null,
"parameters": [
{
"name": "host",
"type": "string",
"required": true,
"description": "Database host, e.g., localhost"
},
{
"name": "port",
"type": "integer",
"required": true,
"description": "Database port, e.g., 3306"
},
{
"name": "user",
"type": "string",
"required": true,
"description": "Database user to connect"
},
{
"name": "database",
"type": "string",
"required": true,
"description": "Database name"
},
{
"name": "driver",
"type": "string",
"required": false,
"description": "Driver name for Doris, default is doris.",
"defaultValue": "doris"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "Database password, you can write your password directly, of course, you can also use environment variables, such as ${env:DBGPT_DB_PASSWORD}",
"defaultValue": "${env:DBGPT_DB_PASSWORD}"
},
{
"name": "pool_size",
"type": "integer",
"required": false,
"description": "Connection pool size, default 5",
"defaultValue": "5"
},
{
"name": "max_overflow",
"type": "integer",
"required": false,
"description": "Max overflow connections, default 10",
"defaultValue": "10"
},
{
"name": "pool_timeout",
"type": "integer",
"required": false,
"description": "Connection pool timeout, default 30",
"defaultValue": "30"
},
{
"name": "pool_recycle",
"type": "integer",
"required": false,
"description": "Connection pool recycle, default 3600",
"defaultValue": "3600"
},
{
"name": "pool_pre_ping",
"type": "boolean",
"required": false,
"description": "Connection pool pre ping, default True",
"defaultValue": "True"
}
]
}} />
---
title: "DuckDB datasource Configuration"
description: "In-memory analytical database with efficient query processing."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "DuckDbConnectorParameters",
"description": "In-memory analytical database with efficient query processing.",
"documentationUrl": null,
"parameters": [
{
"name": "path",
"type": "string",
"required": true,
"description": "Path to the DuckDB file."
},
{
"name": "driver",
"type": "string",
"required": false,
"description": "Driver name for DuckDB, default is duckdb.",
"defaultValue": "duckdb"
}
]
}} />
---
title: "Apache Hive datasource Configuration"
description: "A distributed fault-tolerant data warehouse system."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "HiveParameters",
"description": "A distributed fault-tolerant data warehouse system.",
"documentationUrl": null,
"parameters": [
{
"name": "host",
"type": "string",
"required": true,
"description": "Hive server host"
},
{
"name": "port",
"type": "integer",
"required": false,
"description": "Hive server port, default 10000",
"defaultValue": "10000"
},
{
"name": "database",
"type": "string",
"required": false,
"description": "Database name, default 'default'",
"defaultValue": "default"
},
{
"name": "auth",
"type": "string",
"required": false,
"description": "Authentication mode: NONE, NOSASL, LDAP, KERBEROS, CUSTOM",
"defaultValue": "NONE",
"validValues": [
"NONE",
"NOSASL",
"LDAP",
"KERBEROS",
"CUSTOM"
]
},
{
"name": "username",
"type": "string",
"required": false,
"description": "Username for authentication",
"defaultValue": ""
},
{
"name": "password",
"type": "string",
"required": false,
"description": "Password for LDAP or CUSTOM auth",
"defaultValue": ""
},
{
"name": "kerberos_service_name",
"type": "string",
"required": false,
"description": "Kerberos service name",
"defaultValue": "hive"
},
{
"name": "transport_mode",
"type": "string",
"required": false,
"description": "Transport mode: binary or http",
"defaultValue": "binary"
},
{
"name": "driver",
"type": "string",
"required": false,
"description": "Driver name for Hive, default is hive.",
"defaultValue": "hive"
}
]
}} />
---
title: "MSSQL datasource Configuration"
description: "Powerful, scalable, secure relational database system by Microsoft."
---
import { ConfigDetail } from "@site/src/components/mdx/ConfigDetail";
<ConfigDetail config={{
"name": "MSSQLParameters",
"description": "Powerful, scalable, secure relational database system by Microsoft.",
"documentationUrl": null,
"parameters": [
{
"name": "host",
"type": "string",
"required": true,
"description": "Database host, e.g., localhost"
},
{
"name": "port",
"type": "integer",
"required": true,
"description": "Database port, e.g., 3306"
},
{
"name": "user",
"type": "string",
"required": true,
"description": "Database user to connect"
},
{
"name": "database",
"type": "string",
"required": true,
"description": "Database name"
},
{
"name": "driver",
"type": "string",
"required": false,
"description": "Driver name for MSSQL, default is mssql+pymssql.",
"defaultValue": "mssql+pymssql"
},
{
"name": "password",
"type": "string",
"required": false,
"description": "Database password, you can write your password directly, of course, you can also use environment variables, such as ${env:DBGPT_DB_PASSWORD}",
"defaultValue": "${env:DBGPT_DB_PASSWORD}"
},
{
"name": "pool_size",
"type": "integer",
"required": false,
"description": "Connection pool size, default 5",
"defaultValue": "5"
},
{
"name": "max_overflow",
"type": "integer",
"required": false,
"description": "Max overflow connections, default 10",
"defaultValue": "10"
},
{
"name": "pool_timeout",
"type": "integer",
"required": false,
"description": "Connection pool timeout, default 30",
"defaultValue": "30"
},
{
"name": "pool_recycle",
"type": "integer",
"required": false,
"description": "Connection pool recycle, default 3600",
"defaultValue": "3600"
},
{
"name": "pool_pre_ping",
"type": "boolean",
"required": false,
"description": "Connection pool pre ping, default True",
"defaultValue": "True"
}
]
}} />
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