langchain_community.vectorstores.hanavector
.HanaDB¶
- class langchain_community.vectorstores.hanavector.HanaDB(connection: dbapi.Connection, embedding: Embeddings, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, table_name: str = 'EMBEDDINGS', content_column: str = 'VEC_TEXT', metadata_column: str = 'VEC_META', vector_column: str = 'VEC_VECTOR', vector_column_length: int = - 1)[source]¶
SAP HANA云矢量引擎
使用此类的先决条件是安装``hdbcli`` Python包。
可以通过提供嵌入函数和现有数据库连接来创建HanaDB向量存储。可选地,可以提供要使用的表和列的名称。
Attributes
embeddings
如果可用,访问查询嵌入对象。
Methods
__init__
(connection, embedding[, ...])aadd_documents
(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
aadd_texts
(texts[, metadatas])运行更多的文本通过嵌入,并添加到向量存储中。
add_documents
(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
add_texts
(texts[, metadatas, embeddings])将更多文本添加到向量存储中。
adelete
([ids, filter])根据向量ID或其他条件删除。
afrom_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
afrom_texts
(texts, embedding[, metadatas])返回从文本和嵌入初始化的VectorStore。
amax_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从此VectorStore初始化的VectorStoreRetriever。
asearch
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
asimilarity_search
(query[, k])返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性分数在范围[0, 1]内,异步执行。
asimilarity_search_with_score
(*args, **kwargs)使用异步方式运行相似性搜索与距离。
delete
([ids, filter])根据元数据值筛选删除条目
from_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
from_texts
(texts, embedding[, metadatas, ...])从原始文档创建一个HanaDB实例。 这是一个用户友好的接口,可以: 1. 嵌入文档。 2. 如果表尚不存在,则创建表。 3. 将文档添加到表中。 这旨在是一个快速入门的方式。.
max_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
search
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
similarity_search
(query[, k, filter])返回与查询最相似的文档。
similarity_search_by_vector
(embedding[, k, ...])返回与嵌入向量最相似的文档。
返回文档和相关性得分在[0, 1]范围内。
similarity_search_with_score
(query[, k, filter])返回与查询最相似的文档和分数值。
返回与给定嵌入最相似的文档。
similarity_search_with_score_by_vector
(embedding)返回与给定嵌入最相似的文档。
- Parameters
connection (dbapi.Connection) –
embedding (Embeddings) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_column (str) –
metadata_column (str) –
vector_column (str) –
vector_column_length (int) –
- __init__(connection: dbapi.Connection, embedding: Embeddings, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, table_name: str = 'EMBEDDINGS', content_column: str = 'VEC_TEXT', metadata_column: str = 'VEC_META', vector_column: str = 'VEC_VECTOR', vector_column_length: int = - 1)[source]¶
- Parameters
connection (dbapi.Connection) –
embedding (Embeddings) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_column (str) –
metadata_column (str) –
vector_column (str) –
vector_column_length (int) –
- 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, embeddings: Optional[List[List[float]]] = None, **kwargs: Any) → List[str][source]¶
将更多文本添加到向量存储中。
- 参数:
texts(Iterable[str]):要添加到向量存储中的字符串/文本的可迭代对象。 metadatas(Optional[List[dict],可选):元数据的可选列表。默认为None。 embeddings(Optional[List[List[float]]],可选):可选的预生成的嵌入。默认为None。
- 返回:
List[str]:空列表
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
embeddings (Optional[List[List[float]]]) –
kwargs (Any) –
- Return type
List[str]
- async adelete(ids: Optional[List[str]] = None, filter: Optional[dict] = None) → Optional[bool][source]¶
根据向量ID或其他条件删除。
- 参数:
ids:要删除的ID列表。
- 返回:
可选[bool]:如果删除成功则为True,否则为False,如果未实现则为None。
- Parameters
ids (Optional[List[str]]) –
filter (Optional[dict]) –
- 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) → List[Document][source]¶
返回使用最大边际相关性选择的文档。
- Parameters
embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
- 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
- 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, filter: Optional[dict] = None) → Optional[bool][source]¶
根据元数据值筛选删除条目
- 参数:
ids: 不支持使用ids进行删除!将引发ValueError。 filter: 用于筛选的元数据字段和值的字典。
空的筛选条件({})将删除表中的所有条目。
- 返回:
Optional[bool]: 如果删除成功,则为True。 由于不匹配的筛选条件导致零条目被删除也算是成功。
- Parameters
ids (Optional[List[str]]) –
filter (Optional[dict]) –
- 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, connection: dbapi.Connection = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, table_name: str = 'EMBEDDINGS', content_column: str = 'VEC_TEXT', metadata_column: str = 'VEC_META', vector_column: str = 'VEC_VECTOR', vector_column_length: int = - 1)[source]¶
从原始文档创建一个HanaDB实例。 这是一个用户友好的接口,可以:
嵌入文档。
如果表尚不存在,则创建表。
将文档添加到表中。
这旨在是一个快速入门的方式。
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
connection (dbapi.Connection) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_column (str) –
metadata_column (str) –
vector_column (str) –
vector_column_length (int) –
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[dict] = None) → List[Document][source]¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
query:搜索查询文本。 k:要返回的文档数量。默认为4。 fetch_k:要获取以传递给MMR算法的文档数量。 lambda_mult:介于0和1之间的数字,确定结果之间多样性的程度,
其中0对应于最大多样性,1对应于最小多样性。 默认为0.5。
- filter:过滤元数据属性,例如
- {
“str_property”: “foo”, “int_property”: 123
}
- 返回:
通过最大边际相关性选择的文档列表。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[dict]) –
- 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, filter: Optional[dict] = None) → List[Document][source]¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
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) –
filter (Optional[dict]) –
- 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, filter: Optional[dict] = None) → List[Document][source]¶
返回与查询最相似的文档。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 filter:要过滤的元数据字段和值的字典。
默认为None。
- 返回:
与查询最相似的文档列表。
- Parameters
query (str) –
k (int) –
filter (Optional[dict]) –
- Return type
List[Document]
- similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Document][source]¶
返回与嵌入向量最相似的文档。
- 参数:
embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 要过滤的元数据字段和值的字典。
默认为None。
- 返回:
与查询向量最相似的文档列表。
- Parameters
embedding (List[float]) –
k (int) –
filter (Optional[dict]) –
- 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, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶
返回与查询最相似的文档和分数值。
- 参数:
query: 要查找相似文档的文本。 k: 要返回的文档数量。默认为4。 filter: 要筛选的元数据字段和值的字典。
默认为None。
- 返回:
包含文档和分数的元组列表,这些文档最相似于查询。
- Parameters
query (str) –
k (int) –
filter (Optional[dict]) –
- Return type
List[Tuple[Document, float]]
- similarity_search_with_score_and_vector_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float, List[float]]][source]¶
返回与给定嵌入最相似的文档。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 filter:要过滤的元数据字段和值的字典。
默认为None。
- 返回:
与查询最相似的文档列表 每个文档的得分和嵌入向量。
- Parameters
embedding (List[float]) –
k (int) –
filter (Optional[dict]) –
- Return type
List[Tuple[Document, float, List[float]]]
- similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶
返回与给定嵌入最相似的文档。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 filter:要过滤的元数据字段和值的字典。
默认为None。
- 返回:
与查询最相似的文档列表,以及每个文档的分数。
- Parameters
embedding (List[float]) –
k (int) –
filter (Optional[dict]) –
- Return type
List[Tuple[Document, float]]