Skip to content

docs(vector-store): 完善向量库配置使用文档 - #595

Merged
zxuexingzhijie merged 1 commit into
spring-ai-alibaba:mainfrom
yyyCode:docs/complete-vector-store-config
Aug 6, 2026
Merged

docs(vector-store): 完善向量库配置使用文档#595
zxuexingzhijie merged 1 commit into
spring-ai-alibaba:mainfrom
yyyCode:docs/complete-vector-store-config

Conversation

@yyyCode

@yyyCode yyyCode commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

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.mdDEVELOPER_GUIDE-en.md 的向量库配置表原先遗漏了 3 个 VectorStoreProperties 中实际存在的参数,现已补充:
    • embedding-dimension(持久化向量库维度校验,默认 0 关闭)
    • hybrid-search-timeout-ms(混合检索分支超时,默认 3000ms)
    • file-pathSimpleVectorStore 本地序列化路径)
    • 同时为 enable-hybrid-searchtable-similarity-threshold 等补充了更清晰的说明。
  • 修正步骤序号错误:依赖扩展步骤原为 1 / 2 / 2,修正为 1 / 2 / 3,并新增第 4 步说明 embedding-dimension 的设置建议。
  • 新增开箱即用示例:文档化仓库内已存在但此前未被提及的 application-milvus.ymlapplication-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.javaVectorStoreProperties 的字段一致。
  • 对照文档中的示例 Profile 与 data-agent-management/src/main/resources/application-milvus.ymlapplication-elasticsearch.yml 内容一致。
  • 检查文档内锚点链接可正常跳转。

Special notes for reviews

首次贡献,如对措辞或结构有调整建议,欢迎指出。

补全向量库配置参数表中遗漏的 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>

@zxuexingzhijie zxuexingzhijie left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@zxuexingzhijie
zxuexingzhijie merged commit ab12040 into spring-ai-alibaba:main Aug 6, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] 向量库的配置使用文档可以详细完善一下

2 participants