Skip to main content
Open In ColabOpen on GitHub

Meilisearch

Meilisearch 是一个开源、极速且高度相关的搜索引擎。它提供了出色的默认设置,帮助开发者构建快速的搜索体验。

你可以自托管Meilisearch或在Meilisearch云上运行。

Meilisearch v1.3 支持向量搜索。本页将指导您如何将 Meilisearch 集成为一个向量存储,并使用它来执行向量搜索。

你需要安装 langchain-community 使用 pip install -qU langchain-community 来使用这个集成

设置

启动一个 Meilisearch 实例

您需要一个正在运行的Meilisearch实例作为您的向量存储。您可以在本地运行Meilisearch或创建一个Meilisearch Cloud账户。

截至 Meilisearch v1.3,向量存储是一项实验性功能。启动 Meilisearch 实例后,您需要启用向量存储。对于自托管的 Meilisearch,请阅读有关启用实验性功能的文档。在Meilisearch Cloud上,通过项目的设置页面启用向量存储

你现在应该已经有一个运行中的Meilisearch实例,并且启用了向量存储功能。🎉

凭证

要与您的Meilisearch实例进行交互,Meilisearch SDK需要一个主机(您的实例的URL)和一个API密钥。

主机

  • 本地,默认主机是localhost:7700
  • Meilisearch Cloud上,在项目的设置页面中找到主机

API密钥

Meilisearch 实例为您提供了三个开箱即用的 API 密钥:

  • 一个 MASTER KEY — 它应该仅用于创建您的 Meilisearch 实例
  • 一个 ADMIN KEY — 仅在服务器端使用它来更新您的数据库及其设置
  • 一个SEARCH KEY — 一个你可以在前端应用程序中安全共享的密钥

您可以根据需要创建额外的API密钥

安装依赖

本指南使用Meilisearch Python SDK。您可以通过运行以下命令来安装它:

%pip install --upgrade --quiet  meilisearch

欲了解更多信息,请参阅Meilisearch Python SDK 文档

示例

有多种方法可以初始化Meilisearch向量存储:根据需要提供Meilisearch客户端或URLAPI密钥。在我们的示例中,凭证将从环境中加载。

你可以通过使用osgetpass在你的Notebook环境中提供环境变量。你可以对所有以下示例使用这种技术。

import getpass
import os

if "MEILI_HTTP_ADDR" not in os.environ:
os.environ["MEILI_HTTP_ADDR"] = getpass.getpass(
"Meilisearch HTTP address and port:"
)
if "MEILI_MASTER_KEY" not in os.environ:
os.environ["MEILI_MASTER_KEY"] = getpass.getpass("Meilisearch API Key:")

我们想要使用OpenAIEmbeddings,所以我们必须获取OpenAI API密钥。

if "OPENAI_API_KEY" not in os.environ:
os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:")

添加文本和嵌入

此示例将文本添加到Meilisearch向量数据库,而无需初始化Meilisearch向量存储。

from langchain_community.vectorstores import Meilisearch
from langchain_openai import OpenAIEmbeddings
from langchain_text_splitters import CharacterTextSplitter

embeddings = OpenAIEmbeddings()
embedders = {
"default": {
"source": "userProvided",
"dimensions": 1536,
}
}
embedder_name = "default"
with open("../../how_to/state_of_the_union.txt") as f:
state_of_the_union = f.read()
text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)
texts = text_splitter.split_text(state_of_the_union)
# Use Meilisearch vector store to store texts & associated embeddings as vector
vector_store = Meilisearch.from_texts(
texts=texts, embedding=embeddings, embedders=embedders, embedder_name=embedder_name
)

在幕后,Meilisearch 会将文本转换为多个向量。这将使我们得到与以下示例相同的结果。

添加文档和嵌入

在这个例子中,我们将使用Langchain TextSplitter将文本分割成多个文档。然后,我们将这些文档及其嵌入存储起来。

from langchain_community.document_loaders import TextLoader

# Load text
loader = TextLoader("../../how_to/state_of_the_union.txt")
documents = loader.load()
text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)

# Create documents
docs = text_splitter.split_documents(documents)

# Import documents & embeddings in the vector store
vector_store = Meilisearch.from_documents(
documents=documents,
embedding=embeddings,
embedders=embedders,
embedder_name=embedder_name,
)

# Search in our vector store
query = "What did the president say about Ketanji Brown Jackson"
docs = vector_store.similarity_search(query, embedder_name=embedder_name)
print(docs[0].page_content)
API Reference:TextLoader

通过创建Meilisearch向量存储添加文档

在这种方法中,我们创建一个向量存储对象并向其中添加文档。

import meilisearch
from langchain_community.vectorstores import Meilisearch

client = meilisearch.Client(url="http://127.0.0.1:7700", api_key="***")
vector_store = Meilisearch(
embedding=embeddings,
embedders=embedders,
client=client,
index_name="langchain_demo",
text_key="text",
)
vector_store.add_documents(documents)
API Reference:Meilisearch

带分数的相似性搜索

这个特定的方法允许你返回文档及其与查询的距离分数。embedder_name 是用于语义搜索的嵌入器的名称,默认为 "default"。

docs_and_scores = vector_store.similarity_search_with_score(
query, embedder_name=embedder_name
)
docs_and_scores[0]

向量相似性搜索

embedder_name 是用于语义搜索的嵌入器的名称,默认为 "default"。

embedding_vector = embeddings.embed_query(query)
docs_and_scores = vector_store.similarity_search_by_vector(
embedding_vector, embedder_name=embedder_name
)
docs_and_scores[0]

其他资源

文档

开源仓库


这个页面有帮助吗?