langchain_community.vectorstores.meilisearch.Meilisearch

class langchain_community.vectorstores.meilisearch.Meilisearch(embedding: Embeddings, client: Optional[Client] = None, url: Optional[str] = None, api_key: Optional[str] = None, index_name: str = 'langchain-demo', text_key: str = 'text', metadata_key: str = 'metadata', *, embedders: Optional[Dict[str, Any]] = None)[source]

`Meilisearch`向量存储。

要使用此功能，您需要安装`meilisearch` python包，并运行一个Meilisearch实例。

要了解更多关于Meilisearch Python的信息，请参考深入的Meilisearch Python文档：https://meilisearch.github.io/meilisearch-python/。

查看以下文档以了解如何运行Meilisearch实例： https://www.meilisearch.com/docs/learn/getting_started/quick_start。

示例：
from langchain_community.vectorstores import Meilisearch
from langchain_community.embeddings.openai import OpenAIEmbeddings
import meilisearch

# api_key是可选的；如果您的meilisearch实例需要，请提供
client = meilisearch.Client(url='http://127.0.0.1:7700', api_key='***')
embeddings = OpenAIEmbeddings()
embedders = {
    "theEmbedderName": {
        "source": "userProvided",
        "dimensions": "1536"
    }
}
vectorstore = Meilisearch(
    embedding=embeddings,
    embedders=embedders,
    client=client,
    index_name='langchain_demo',
    text_key='text')

使用Meilisearch客户端进行初始化。

Attributes

embeddings

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

Methods

__init__(embedding[, client, url, api_key, ...])

使用Meilisearch客户端进行初始化。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas, ids, embedder_name])

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

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, ...])

从原始文档构建Meilisearch包装器。

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

similarity_search(query[, k, filter, ...])

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

similarity_search_by_vector(embedding[, k, ...])

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

similarity_search_by_vector_with_scores(...)

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

similarity_search_with_relevance_scores(query)

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

similarity_search_with_score(query[, k, ...])

返回与查询最相似的meilisearch文档，以及分数。
Parameters

  • embedding (Embeddings) –

  • client (Optional[Client]) –

  • url (Optional[str]) –

  • api_key (Optional[str]) –

  • index_name (str) –

  • text_key (str) –

  • metadata_key (str) –

  • embedders (Optional[Dict[str, Any]]) –

__init__(embedding: Embeddings, client: Optional[Client] = None, url: Optional[str] = None, api_key: Optional[str] = None, index_name: str = 'langchain-demo', text_key: str = 'text', metadata_key: str = 'metadata', *, embedders: Optional[Dict[str, Any]] = None)[source]

使用Meilisearch客户端进行初始化。

Parameters

  • embedding (Embeddings) –

  • client (Optional[Client]) –

  • url (Optional[str]) –

  • api_key (Optional[str]) –

  • index_name (str) –

  • text_key (str) –

  • metadata_key (str) –

  • embedders (Optional[Dict[str, Any]]) –

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, embedder_name: Optional[str] = 'default', **kwargs: Any) → List[str][source]

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

参数:

texts (Iterable[str]): 要添加到向量存储中的字符串/文本的可迭代对象。 embedder_name: 嵌入器的名称。默认为”default”。 metadatas (Optional[List[dict]]): 可选的元数据列表。

默认为None。

ids Optional[List[str]]: 可选的ID列表。

默认为None。

返回:

List[str]: 已添加到向量存储中的文本的ID列表。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • ids (Optional[List[str]]) –

  • embedder_name (Optional[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
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

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

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

参数：

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]

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

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
Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, client: Optional[Client] = None, url: Optional[str] = None, api_key: Optional[str] = None, index_name: str = 'langchain-demo', ids: Optional[List[str]] = None, text_key: Optional[str] = 'text', metadata_key: Optional[str] = 'metadata', embedders: Dict[str, Any] = {}, embedder_name: Optional[str] = 'default', **kwargs: Any) → Meilisearch[source]

从原始文档构建Meilisearch包装器。

这是一个用户友好的接口，可以：

  1. 嵌入文档。

  2. 将文档添加到提供的Meilisearch索引中。

这旨在是一个快速入门的方式。

示例：
from langchain_community.vectorstores import Meilisearch
from langchain_community.embeddings import OpenAIEmbeddings
import meilisearch

# 环境应该是在Meilisearch控制台中API密钥旁边指定的那个
client = meilisearch.Client(url='http://127.0.0.1:7700', api_key='***')
embedding = OpenAIEmbeddings()
embedders: Embedders index setting.
embedder_name: 嵌入器的名称。默认为"default"。
docsearch = Meilisearch.from_texts(
    client=client,
    embedding=embedding,
)
Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • client (Optional[Client]) –

  • url (Optional[str]) –

  • api_key (Optional[str]) –

  • index_name (str) –

  • ids (Optional[List[str]]) –

  • text_key (Optional[str]) –

  • metadata_key (Optional[str]) –

  • embedders (Dict[str, Any]) –

  • embedder_name (Optional[str]) –

  • kwargs (Any) –

Return type

Meilisearch

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

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

参数：

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]

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

参数:

query (str): 要查找相似文档的查询文本。 embedder_name: 要使用的嵌入器的名称。默认为”default”。 k (int): 要返回的文档数量。默认为4。 filter (Optional[Dict[str, str]]): 按元数据过滤。

默认为None。

返回:

List[Document]: 查询最相似的文档列表 每个文档的文本和分数。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • embedder_name (Optional[str]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, str]] = None, embedder_name: Optional[str] = 'default', **kwargs: Any) → List[Document][source]

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

参数：

embedding（List[float]）：要查找相似文档的嵌入向量。 embedder_name：要使用的嵌入器的名称。默认为”default”。 k（int）：要返回的文档数量。默认为4。 filter（Optional[Dict[str, str]]）：按元数据筛选。默认为None。

返回：

List[Document]：与查询向量最相似的文档列表，以及每个文档的分数。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • embedder_name (Optional[str]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector_with_scores(embedding: List[float], embedder_name: Optional[str] = 'default', k: int = 4, filter: Optional[Dict[str, Any]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

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

参数：

embedding（List[float]）：要查找相似文档的嵌入向量。 embedder_name：要使用的嵌入器的名称。默认为”default”。 k（int）：要返回的文档数量。默认为4。 filter（Optional[Dict[str, str]]）：按元数据筛选。默认为None。

返回：

List[Document]：与查询向量最相似的文档列表，以及每个文档的分数。

Parameters

  • embedding (List[float]) –

  • embedder_name (Optional[str]) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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[str, str]] = None, embedder_name: Optional[str] = 'default', **kwargs: Any) → List[Tuple[Document, float]][source]

返回与查询最相似的meilisearch文档，以及分数。

参数：

query (str): 要查找相似文档的查询文本。 embedder_name: 要使用的嵌入器的名称。默认为”default”。 k (int): 要返回的文档数量。默认为4。 filter (Optional[Dict[str, str]]): 按元数据筛选。

默认为None。

返回：

List[Document]: 与查询最相似的文档列表 每个文档的文本和分数。

Parameters

  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, str]]) –

  • embedder_name (Optional[str]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using Meilisearch