docs(vector-store): 完善向量库配置使用文档 - #595
Merged
zxuexingzhijie merged 1 commit intoAug 6, 2026
Merged
Conversation
补全向量库配置参数表中遗漏的 embedding-dimension、hybrid-search-timeout-ms、 file-path 参数;修正依赖扩展步骤序号错误(1/2/2 -> 1/2/3/4);新增开箱即用的 Milvus / Elasticsearch 示例 Profile 说明及激活方式,并在快速开始文档中补充相应 指引。中英文文档同步更新。 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe what this PR does / why we need it
完善向量库(Vector Store)的配置使用文档,解决 #353。当前开发者指南中的向量库章节存在信息缺失和小错误,用户在切换持久化向量库时缺乏可直接参考的完整说明。
Does this pull request fix one issue?
Fixes #353
Describe how you did it
docs/DEVELOPER_GUIDE.md与DEVELOPER_GUIDE-en.md的向量库配置表原先遗漏了 3 个VectorStoreProperties中实际存在的参数,现已补充:embedding-dimension(持久化向量库维度校验,默认 0 关闭)hybrid-search-timeout-ms(混合检索分支超时,默认 3000ms)file-path(SimpleVectorStore本地序列化路径)enable-hybrid-search、table-similarity-threshold等补充了更清晰的说明。1 / 2 / 2,修正为1 / 2 / 3,并新增第 4 步说明embedding-dimension的设置建议。application-milvus.yml与application-elasticsearch.yml两个示例 Profile,给出 YAML 内容与SPRING_PROFILES_ACTIVE激活方式,并说明对应 starter 依赖已包含在data-agent-management/pom.xml中。QUICK_START.md/QUICK_START-en.md的「替换 vector-store 实现类」小节增加指向上述示例的链接。本 PR 仅涉及文档,不改动任何代码逻辑。文档中的参数、默认值、Profile 内容均与
DataAgentProperties.VectorStoreProperties及资源目录下的示例配置文件核对一致。Describe how to verify it
docs/DEVELOPER_GUIDE.md第 3 节「向量库配置」,核对参数表与data-agent-management/src/main/java/com/alibaba/cloud/ai/dataagent/properties/DataAgentProperties.java中VectorStoreProperties的字段一致。data-agent-management/src/main/resources/application-milvus.yml、application-elasticsearch.yml内容一致。Special notes for reviews
首次贡献,如对措辞或结构有调整建议,欢迎指出。