langchain_community.vectorstores.dashvector.DashVector¶
- class langchain_community.vectorstores.dashvector.DashVector(collection: Any, embedding: Embeddings, text_field: str)[source]¶
`DashVector`向量存储。
要使用，您应该已安装``dashvector`` Python包。
- 示例:
from langchain_community.vectorstores import DashVector from langchain_community.embeddings.openai import OpenAIEmbeddings import dashvector client = dashvector.Client(api_key="***") client.create("langchain", dimension=1024) collection = client.get("langchain") embeddings = OpenAIEmbeddings() vectorstore = DashVector(collection, embeddings.embed_query, "text")
使用DashVector集合进行初始化。
Attributes
embeddings如果可用，访问查询嵌入对象。
Methods
__init__(collection, embedding, text_field)使用DashVector集合进行初始化。
aadd_documents(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas])运行更多的文本通过嵌入，并添加到向量存储中。
add_documents(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
add_texts(texts[, metadatas, ids, ...])运行更多的文本通过嵌入并添加到向量存储中。
adelete([ids])根据向量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, partition])根据向量ID删除。
from_documents(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
from_texts(texts, embedding[, metadatas, ...])返回从文本和嵌入初始化的DashVector VectorStore。
max_marginal_relevance_search(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
search(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
similarity_search(query[, k, filter, partition])返回与查询最相似的文档。
similarity_search_by_vector(embedding[, k, ...])返回与嵌入向量最相似的文档。
返回与查询文本最相似的文档，以及相关性分数。
similarity_search_with_score(*args, **kwargs)使用距离进行相似性搜索。
- Parameters
collection (Any) –
embedding (Embeddings) –
text_field (str) –
- __init__(collection: Any, embedding: Embeddings, text_field: str)[source]¶
使用DashVector集合进行初始化。
- Parameters
collection (Any) –
embedding (Embeddings) –
text_field (str) –
- 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, ids: Optional[List[str]] = None, batch_size: int = 25, partition: str = 'default', **kwargs: Any) List[str][source]¶
运行更多的文本通过嵌入并添加到向量存储中。
- 参数：
texts：要添加到向量存储中的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：与文本相关联的id的可选列表。 batch_size：更新文档的可选批量大小。 partition：集合中的一个分区名称。[可选]。 kwargs：向量存储特定参数
- 返回：
将文本添加到向量存储中的id列表。
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
batch_size (int) –
partition (str) –
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
- 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, partition: str = 'default', **kwargs: Any) bool[source]¶
根据向量ID删除。
- 参数：
ids：要删除的ID列表。 partition：集合中的一个分区名称。[可选]。
- 返回：
如果删除成功，则为True， 否则为False。
- Parameters
ids (Optional[List[str]]) –
partition (str) –
kwargs (Any) –
- Return type
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, dashvector_api_key: Optional[str] = None, dashvector_endpoint: Optional[str] = None, collection_name: str = 'langchain', text_field: str = 'text', batch_size: int = 25, ids: Optional[List[str]] = None, **kwargs: Any) DashVector[source]¶
返回从文本和嵌入初始化的DashVector VectorStore。
这是使用dashvector向量存储快速开始的方法。
- 示例：
from langchain_community.vectorstores import DashVector from langchain_community.embeddings import OpenAIEmbeddings import dashvector
embeddings = OpenAIEmbeddings() dashvector = DashVector.from_documents(
docs, embeddings, dashvector_api_key=”{DASHVECTOR_API_KEY}”
)
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
dashvector_api_key (Optional[str]) –
dashvector_endpoint (Optional[str]) –
collection_name (str) –
text_field (str) –
batch_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[dict] = None, partition: str = 'default', **kwargs: Any) List[Document][source]¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数：
embedding: 查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 满足SQL where子句规范的文档字段过滤条件。 partition: 集合中的分区名称。[可选]。
- 返回：
通过最大边际相关性选择的文档列表。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[dict]) –
partition (str) –
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, filter: Optional[dict] = None, partition: str = 'default', **kwargs: Any) List[Document][source]¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数：
embedding: 查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，
其中0对应于最大多样性，1对应于最小多样性。 默认为0.5。
filter: 满足SQL where子句规范的文档字段过滤条件。 partition: 集合中的一个分区名称。[可选]。
- 返回：
通过最大边际相关性选择的文档列表。
- Parameters
embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[dict]) –
partition (str) –
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, filter: Optional[str] = None, partition: str = 'default', **kwargs: Any) List[Document][source]¶
返回与查询最相似的文档。
- 参数：
query：要搜索与之相似文档的文本。 k：要返回的文档数量。默认为4。 filter：满足SQL where子句规范的文档字段过滤条件。 partition：集合中的一个分区名称。[可选]。
- 返回：
与查询文本最相似的文档列表。
- Parameters
query (str) –
k (int) –
filter (Optional[str]) –
partition (str) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[str] = None, partition: str = 'default', **kwargs: Any) List[Document][source]¶
返回与嵌入向量最相似的文档。
- 参数：
embedding: 要查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 满足SQL where子句规范的文档字段过滤条件。 partition: 集合中的一个分区名称。[可选]。
- 返回：
与查询向量最相似的文档列表。
- Parameters
embedding (List[float]) –
k (int) –
filter (Optional[str]) –
partition (str) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_with_relevance_scores(query: str, k: int = 4, filter: Optional[str] = None, partition: str = 'default', **kwargs: Any) List[Tuple[Document, float]][source]¶
返回与查询文本最相似的文档，以及相关性分数。
Less表示更相似，more表示更不相似。
- 参数：
query：输入文本 k：要返回的文档数量。默认为4。 filter：满足SQL where子句规范的文档字段过滤条件。 partition：集合中的一个分区名称。[可选]。
- 返回：
元组列表（doc，similarity_score）
- Parameters
query (str) –
k (int) –
filter (Optional[str]) –
partition (str) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]