讲师中心 微信公众号
AI工具推荐 视频效率加速

ChromaDB 中 include 参数的正确使用方式详解

冬萱姑娘_4512

冬萱姑娘_4512

发布时间:2026-05-20 09:35:22

|

314人浏览过

|

来源于php中文网

原创

ChromaDB 中 include 参数的正确使用方式详解

include 参数仅适用于 get() 和 query() 方法,不可用于 add();调用 add() 时传入 include 会导致 TypeError。如需获取嵌入向量、元数据等完整信息,应在检索阶段通过 include 显式声明所需字段。

`include` 参数仅适用于 `get()` 和 `query()` 方法,不可用于 `add()`;调用 `add()` 时传入 `include` 会导致 `typeerror`。如需获取嵌入向量、元数据等完整信息,应在检索阶段通过 `include` 显式声明所需字段。

在 ChromaDB 中,Collection.add() 方法的作用是向集合中插入数据,其职责仅限于写入:文档、元数据、ID 和(可选)预计算的嵌入向量。它不返回任何结果,也不支持 include 参数——该参数的设计初衷是控制读取操作(即 get 或 query)中返回哪些字段,例如嵌入向量('embeddings')、原始文档('documents')、元数据('metadatas')或相似度距离('distances')。

✅ 正确用法示例:

# ✅ 添加数据(无需且不可指定 include)
collection.add(
    documents=["This is a document", "This is another document"],
    metadatas=[{"source": "test_source", "page": 1}, {"source": "test_source2", "page": 2}],
    ids=["id1", "id2"]
    # ❌ 删除 include=['...'] —— 此处会报错 TypeError
)

# ✅ 检索时按需包含字段
results = collection.get(
    ids=["id1", "id2"],
    include=['documents', 'metadatas', 'embeddings']
)
print("Embeddings:", results['embeddings'])  # 现在可安全访问嵌入向量

# ✅ 或执行语义查询并获取多维度结果
query_result = collection.query(
    query_texts=["a related topic"],
    n_results=2,
    include=['documents', 'metadatas', 'distances', 'embeddings']
)
print("Top match distance:", query_result['distances'][0][0])
print("Corresponding embedding shape:", len(query_result['embeddings'][0][0]))

⚠️ 注意事项:

  • include 的可选值为 ['documents', 'metadatas', 'embeddings', 'distances'],超出范围会引发 ValueError;
  • 'embeddings' 仅在启用了嵌入函数(或手动传入 embeddings=)且未禁用持久化时才可用;
  • 若未显式指定 include,默认仅返回 ids 和 documents(get)或 ids(query),其余字段为空;
  • add() 方法成功后不会触发嵌入计算延迟——ChromaDB 会在首次 query 或显式 collection.peek() 时按需生成(取决于客户端配置与嵌入模型是否就绪)。

总结:add() 是“只写”接口,专注数据注入;get()/query() 才是“可配置读取”接口。理解这一职责分离,是高效使用 ChromaDB 的关键基础。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1871

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5104

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1809

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

30737

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3647

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3667

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn