`langchain_community.vectorstores.hippo`.Hippo¶

class langchain_community.vectorstores.hippo.Hippo(embedding_function: Embeddings, table_name: str = 'test', database_name: str = 'default', number_of_shards: int = 1, number_of_replicas: int = 1, connection_args: Optional[Dict[str, Any]] = None, index_params: Optional[dict] = None, drop_old: Optional[bool] = False)[source]¶

Hippo 向量存储。

您需要安装 hippo-api 并运行 Hippo。

请访问我们的官方网站了解如何运行 Hippo 实例： https://www.transwarp.cn/starwarp

参数:

embedding_function (Embeddings): 用于嵌入文本的函数。 table_name (str): 要使用的 Hippo 表。默认为 “test”。 database_name (str): 要使用的 Hippo 数据库。默认为 “default”。 number_of_shards (int): Hippo 表的分片数。默认为 1。 number_of_replicas (int): Hippo 表的副本数。默认为 1。 connection_args (Optional[dict[str, any]]): 用于此类的连接参数以字典形式提供。 index_params (Optional[dict]): 要使用的索引参数。默认为 IVF_FLAT。 drop_old (Optional[bool]): 是否删除当前集合。默认为 False。 primary_field (str): 主键字段的名称。默认为 “pk”。 text_field (str): 文本字段的名称。默认为 “text”。 vector_field (str): 向量字段的名称。默认为 “vector”。

用于此类的连接参数以字典形式提供，以下是一些选项：

host (str): Hippo 实例的主机。默认为 “localhost”。 port (str/int): Hippo 实例的端口。默认为 7788。 user (str): 用于连接到 Hippo 实例的用户。如果提供了用户和密码，我们将在每个 RPC 调用中添加相关的标头。 password (str): 当提供了用户时需要。与用户对应的密码。

示例:

from langchain_community.vectorstores import Hippo from langchain_community.embeddings import OpenAIEmbeddings

embedding = OpenAIEmbeddings() # 连接到本地主机上的 hippo 实例 vector_store = Hippo.from_documents(

docs, embedding=embeddings, table_name=”langchain_test”, connection_args=HIPPO_CONNECTION

)

引发:

ValueError: 如果未安装 hippo-api python 包。

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

`__init__`(embedding_function[, table_name, ...])
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas, timeout, ...])	将文本添加到集合中。
`adelete`([ids])	根据向量ID或其他条件进行删除。
`afrom_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	返回从文本和嵌入初始化的VectorStore。
`amax_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`asimilarity_search`(query[, k])	返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	返回文档和相关性分数在范围[0, 1]内，异步执行。
`asimilarity_search_with_score`(args, *kwargs)	使用异步方式运行相似性搜索与距离。
`delete`([ids])	根据向量ID或其他条件进行删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	从给定的文本创建VST类的实例。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, param, expr, ...])	对查询字符串执行相似性搜索。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, ...])	对查询字符串执行搜索，并返回带有分数的结果。
`similarity_search_with_score_by_vector`(embedding)	对查询字符串执行搜索，并返回带有分数的结果。

Parameters

embedding_function (Embeddings) –
table_name (str) –
database_name (str) –
number_of_shards (int) –
number_of_replicas (int) –
connection_args (Optional[Dict[str, Any]]) –
index_params (Optional[dict]) –
drop_old (Optional[bool]) –

__init__(embedding_function: Embeddings, table_name: str = 'test', database_name: str = 'default', number_of_shards: int = 1, number_of_replicas: int = 1, connection_args: Optional[Dict[str, Any]] = None, index_params: Optional[dict] = None, drop_old: Optional[bool] = False)[source]¶

Parameters

embedding_function (Embeddings) –
table_name (str) –
database_name (str) –
number_of_shards (int) –
number_of_replicas (int) –
connection_args (Optional[Dict[str, Any]]) –
index_params (Optional[dict]) –
drop_old (Optional[bool]) –

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]¶

运行更多的文档通过嵌入并添加到向量存储中。

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

运行更多的文本通过嵌入，并添加到向量存储中。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]¶

运行更多的文档通过嵌入并添加到向量存储中。

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, timeout: Optional[int] = None, batch_size: int = 1000, **kwargs: Any) → List[str][source]¶

将文本添加到集合中。

参数：: texts: 包含要添加的文本的可迭代对象。 metadatas: 一个可选的字典列表，每个字典包含与文本相关联的元数据。 timeout: 可选的超时时间，单位为秒。 batch_size: 每个批次插入的文本数量，默认为1000。 **kwargs: 其他可选参数。
返回：: 一个字符串列表，包含插入文本的唯一标识符。
注意：: 如果集合尚未创建，此方法将创建一个新的集合。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
timeout (Optional[int]) –
batch_size (int) –
kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

返回从文档和嵌入初始化的VectorStore。

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

返回从文本和嵌入初始化的VectorStore。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

VST

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

返回使用最大边际相关性选择的文档。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此VectorStore初始化的VectorStoreRetriever。

参数：

search_type（可选[str]）：定义Retriever应执行的搜索类型。: 可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。
search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：: k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

Parameters: kwargs (Any) –
Return type: VectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]¶

返回使用指定搜索类型的查询最相似的文档。

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

返回与查询最相似的文档。

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

返回与嵌入向量最相似的文档。

Parameters

embedding (List[float]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性分数在范围[0, 1]内，异步执行。

0表示不相似，1表示最相似。

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似度分数）的列表

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

使用异步方式运行相似性搜索与距离。

Parameters

args (Any) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

delete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

返回从文档和嵌入初始化的VectorStore。

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, table_name: str = 'test', database_name: str = 'default', connection_args: Dict[str, Any] = {'host': 'localhost', 'password': 'admin', 'port': '7788', 'username': 'admin'}, index_params: Optional[Dict[Any, Any]] = None, search_params: Optional[Dict[str, Any]] = None, drop_old: bool = False, **kwargs: Any) → Hippo[source]¶

从给定的文本创建VST类的实例。

参数:: texts (List[str]): 要添加的文本列表。 embedding (Embeddings): 文本的嵌入模型。 metadatas (List[dict], optional): 每个文本的元数据字典列表。默认为None。 table_name (str): 表的名称。默认为”test”。 database_name (str): 数据库的名称。默认为”default”。 connection_args (dict[str, Any]): 连接参数。默认为DEFAULT_HIPPO_CONNECTION。 index_params (dict): 索引参数。默认为None。 search_params (dict): 搜索参数。默认为空字典。 drop_old (bool): 是否删除旧集合。默认为False。 kwargs: 其他参数。
返回:: Hippo: VST类的实例。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
table_name (str) –
database_name (str) –
connection_args (Dict[str, Any]) –
index_params (Optional[Dict[Any, Any]]) –
search_params (Optional[Dict[str, Any]]) –
drop_old (bool) –
kwargs (Any) –

Return type

Hippo

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

返回使用指定搜索类型的查询最相似的文档。

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

similarity_search(query: str, k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[int] = None, **kwargs: Any) → List[Document][source]¶

对查询字符串执行相似性搜索。

参数:: query (str): 要搜索的文本。 k (int, optional): 要返回的结果数量。默认为4。 param (dict, optional): 指定索引的搜索参数。默认为None。 expr (str, optional): 过滤表达式。默认为None。 timeout (int, optional): 超时错误前等待的时间。默认为None。 kwargs: Collection.search()的关键字参数。
返回:: List[Document]: 搜索的文档结果。

Parameters

query (str) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[int]) –
kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

返回与嵌入向量最相似的文档。

参数：: embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。
返回：: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性得分在[0, 1]范围内。

0表示不相似，1表示最相似。

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似性得分）

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[int] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

对查询字符串执行搜索，并返回带有分数的结果。

参数:: query (str): 要搜索的文本。 k (int, optional): 要返回的结果数量。默认为4。 param (dict): 指定索引的搜索参数。默认为None。 expr (str, optional): 过滤表达式。默认为None。 timeout (int, optional): 超时错误前的等待时间。默认为None。 kwargs: Collection.search() 的关键字参数。
返回:: List[float], List[Tuple[Document, any, any]]:

Parameters

query (str) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[int]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[int] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

对查询字符串执行搜索，并返回带有分数的结果。

参数：: embedding（List[float]）：正在搜索的嵌入向量。 k（int，可选）：要返回的结果数量。默认为4。 param（dict）：指定索引的搜索参数。默认为None。 expr（str，可选）：过滤表达式。默认为None。 timeout（int，可选）：超时错误之前的等待时间。默认为None。 kwargs：Collection.search()的关键字参数。
返回：: List[Tuple[Document, float]]：结果文档和分数。

Parameters

embedding (List[float]) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[int]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using Hippo¶

openai

langchain_community.vectorstores.hippo.Hippo¶

Examples using Hippo¶

`langchain_community.vectorstores.hippo`.Hippo¶