org.noear.solon.ai.rag.repository.chroma

类 ChromaClient

java.lang.Object

org.noear.solon.ai.rag.repository.chroma.ChromaClient

public class ChromaClient
extends java.lang.Object

Chroma API 客户端

从以下版本开始:

3.1

构造器概要

构造器

构造器和说明
ChromaClient(java.util.Properties properties)
ChromaClient(java.lang.String baseUrl)

方法概要

限定符和类型	方法和说明
void	addDocuments(java.lang.String collectionId, java.util.List<java.lang.String> ids, java.util.List<java.util.List<java.lang.Float>> embeddings, java.util.List<java.lang.String> documents, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> metadatas) 添加文档
CollectionResponse	createCollection(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> metadata) 创建集合
void	deleteCollection(java.lang.String collectionId) 删除集合
void	deleteDocuments(java.lang.String collectionId, java.util.List<java.lang.String> ids) 删除文档
boolean	documentExists(java.lang.String collectionId, java.lang.String id) 检查文档是否存在
CollectionResponse	getCollectionStats(java.lang.String collectionName) 获取集合信息
boolean	isHealthy() 检查服务是否健康
CollectionsResponse	listCollections() 获取所有集合
QueryResponse	queryDocuments(java.lang.String collectionId, java.util.List<java.lang.Float> queryEmbedding, int limit, java.util.Map<java.lang.String,java.lang.Object> metadataFilter) 查询文档
void	setBasicAuth(java.lang.String username, java.lang.String password) 设置基础鉴权
void	setBearerAuth(java.lang.String token) 设置令牌鉴权

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ChromaClient

public ChromaClient(java.lang.String baseUrl)

ChromaClient

public ChromaClient(java.util.Properties properties)

方法详细资料

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password)

设置基础鉴权

setBearerAuth

public void setBearerAuth(java.lang.String token)

设置令牌鉴权

isHealthy

public boolean isHealthy()

检查服务是否健康

返回:

是否健康

listCollections

public CollectionsResponse listCollections()
                                    throws java.io.IOException

获取所有集合

返回:

集合列表

抛出:

java.io.IOException - 如果请求失败

createCollection

public CollectionResponse createCollection(java.lang.String name,
                                           java.util.Map<java.lang.String,java.lang.Object> metadata)
                                    throws java.io.IOException

创建集合

参数:

name - 集合名称

metadata - 集合元数据

返回:

集合ID

抛出:

java.io.IOException - 如果创建失败

getCollectionStats

public CollectionResponse getCollectionStats(java.lang.String collectionName)
                                      throws java.io.IOException

获取集合信息

参数:

collectionName - 集合Name

返回:

集合信息

抛出:

java.io.IOException - 如果请求失败

deleteCollection

public void deleteCollection(java.lang.String collectionId)
                      throws java.io.IOException

删除集合

参数:

collectionId - 集合ID

抛出:

java.io.IOException - 如果删除失败

addDocuments

public void addDocuments(java.lang.String collectionId,
                         java.util.List<java.lang.String> ids,
                         java.util.List<java.util.List<java.lang.Float>> embeddings,
                         java.util.List<java.lang.String> documents,
                         java.util.List<java.util.Map<java.lang.String,java.lang.Object>> metadatas)
                  throws java.io.IOException

添加文档

参数:

collectionId - 集合ID

ids - 文档ID列表

embeddings - 文档向量列表

documents - 文档内容列表

metadatas - 文档元数据列表

抛出:

java.io.IOException - 如果添加失败

deleteDocuments

public void deleteDocuments(java.lang.String collectionId,
                            java.util.List<java.lang.String> ids)
                     throws java.io.IOException

删除文档

参数:

collectionId - 集合ID

ids - 文档ID列表

抛出:

java.io.IOException - 如果删除失败

documentExists

public boolean documentExists(java.lang.String collectionId,
                              java.lang.String id)
                       throws java.io.IOException

检查文档是否存在

参数:

collectionId - 集合ID

id - 文档ID

返回:

是否存在

抛出:

java.io.IOException - 如果请求失败

queryDocuments

public QueryResponse queryDocuments(java.lang.String collectionId,
                                    java.util.List<java.lang.Float> queryEmbedding,
                                    int limit,
                                    java.util.Map<java.lang.String,java.lang.Object> metadataFilter)
                             throws java.io.IOException

查询文档

参数:

collectionId - 集合ID

queryEmbedding - 查询向量

limit - 结果数量限制

metadataFilter - 元数据过滤条件

返回:

查询响应

抛出:

java.io.IOException - 如果查询失败