NVIDIA NIMs

langchain-nvidia-ai-endpoints 包包含 LangChain 集成，用于在 NVIDIA NIM 推理微服务上构建应用程序。NIM 支持跨领域的模型，如聊天、嵌入和重新排序模型，这些模型来自社区以及 NVIDIA。这些模型由 NVIDIA 优化，以在 NVIDIA 加速基础设施上提供最佳性能，并作为 NIM 部署，NIM 是一个易于使用的预构建容器，可以在 NVIDIA 加速基础设施上使用单个命令部署到任何地方。

NVIDIA 托管的 NIM 部署可在 NVIDIA API 目录上进行测试。测试完成后，可以使用 NVIDIA AI Enterprise 许可证从 NVIDIA 的 API 目录中导出 NIM，并在本地或云端运行，使企业拥有并完全控制其知识产权和 AI 应用程序。

NIMs 以每个模型为基础打包为容器镜像，并通过 NVIDIA NGC 目录作为 NGC 容器镜像分发。 NIMs 的核心是提供简单、一致且熟悉的 API，用于在 AI 模型上运行推理。

本示例介绍了如何使用LangChain与支持的NVIDIA检索问答嵌入模型进行交互，通过NVIDIAEmbeddings类实现检索增强生成。

有关通过此API访问聊天模型的更多信息，请查看ChatNVIDIA文档。

安装

%pip install --upgrade --quiet  langchain-nvidia-ai-endpoints

设置

开始使用：

创建一个免费账户，使用NVIDIA，该平台托管NVIDIA AI基础模型。
选择Retrieval选项卡，然后选择您想要的模型。
在Input下选择Python标签，然后点击Get API Key。接着点击Generate Key。
复制并保存生成的密钥为NVIDIA_API_KEY。之后，您应该可以访问这些端点。

import getpass
import os

# del os.environ['NVIDIA_API_KEY']  ## delete key and reset
if os.environ.get("NVIDIA_API_KEY", "").startswith("nvapi-"):
    print("Valid NVIDIA_API_KEY already in environment. Delete to reset")
else:
    nvapi_key = getpass.getpass("NVAPI Key (starts with nvapi-): ")
    assert nvapi_key.startswith("nvapi-"), f"{nvapi_key[:5]}... is not a valid key"
    os.environ["NVIDIA_API_KEY"] = nvapi_key

我们应该能够在该列表中看到一个嵌入模型，该模型可以与LLM结合使用以实现有效的RAG解决方案。我们可以通过NVIDIAEmbeddings类与此模型以及NIM支持的其他嵌入模型进行交互。

在NVIDIA API目录中使用NIMs

初始化嵌入模型时，您可以通过传递模型来选择模型，例如下面的NV-Embed-QA，或者不传递任何参数使用默认模型。

from langchain_nvidia_ai_endpoints import NVIDIAEmbeddings

embedder = NVIDIAEmbeddings(model="NV-Embed-QA")

API Reference:NVIDIAEmbeddings

该模型是一个经过微调的E5-large模型，支持预期的Embeddings方法，包括：

embed_query: 为查询样本生成查询嵌入。
embed_documents: 为您希望搜索的文档列表生成段落嵌入。
aembed_query/aembed_documents: 上述功能的异步版本。

使用自托管的NVIDIA NIMs

准备部署时，您可以使用NVIDIA NIM自托管模型——该功能包含在NVIDIA AI Enterprise软件许可证中——并在任何地方运行它们，使您能够拥有自定义内容，并完全控制您的知识产权（IP）和AI应用程序。

了解更多关于NIMs的信息

from langchain_nvidia_ai_endpoints import NVIDIAEmbeddings

# connect to an embedding NIM running at localhost:8080
embedder = NVIDIAEmbeddings(base_url="http://localhost:8080/v1")

API Reference:NVIDIAEmbeddings

相似性

以下是这些数据点相似性的快速测试：

查询:

堪察加半岛的天气怎么样？
意大利以哪些食物闻名？
我的名字是什么？我打赌你不记得了...
生活的意义到底是什么？
生活的意义在于享受乐趣 :D

文档：

堪察加的天气寒冷，冬季漫长而严酷。
意大利以意大利面、披萨、冰淇淋和浓缩咖啡而闻名。
我无法回忆个人姓名，只能提供信息。
生活的目的各不相同，通常被视为个人实现。
享受生活的时刻确实是一种美妙的方式。

嵌入运行时

print("\nSequential Embedding: ")
q_embeddings = [
    embedder.embed_query("What's the weather like in Komchatka?"),
    embedder.embed_query("What kinds of food is Italy known for?"),
    embedder.embed_query("What's my name? I bet you don't remember..."),
    embedder.embed_query("What's the point of life anyways?"),
    embedder.embed_query("The point of life is to have fun :D"),
]
print("Shape:", (len(q_embeddings), len(q_embeddings[0])))

文档嵌入

print("\nBatch Document Embedding: ")
d_embeddings = embedder.embed_documents(
    [
        "Komchatka's weather is cold, with long, severe winters.",
        "Italy is famous for pasta, pizza, gelato, and espresso.",
        "I can't recall personal names, only provide information.",
        "Life's purpose varies, often seen as personal fulfillment.",
        "Enjoying life's moments is indeed a wonderful approach.",
    ]
)
print("Shape:", (len(q_embeddings), len(q_embeddings[0])))

现在我们已经生成了嵌入向量，我们可以对结果进行简单的相似性检查，看看哪些文档会在检索任务中被触发为合理的答案：

%pip install --upgrade --quiet  matplotlib scikit-learn

import matplotlib.pyplot as plt
import numpy as np
from sklearn.metrics.pairwise import cosine_similarity

# Compute the similarity matrix between q_embeddings and d_embeddings
cross_similarity_matrix = cosine_similarity(
    np.array(q_embeddings),
    np.array(d_embeddings),
)

# Plotting the cross-similarity matrix
plt.figure(figsize=(8, 6))
plt.imshow(cross_similarity_matrix, cmap="Greens", interpolation="nearest")
plt.colorbar()
plt.title("Cross-Similarity Matrix")
plt.xlabel("Query Embeddings")
plt.ylabel("Document Embeddings")
plt.grid(True)
plt.show()

提醒一下，发送到我们系统的查询和文档是：

查询:

堪察加半岛的天气怎么样？
意大利以哪些食物闻名？
我的名字是什么？我打赌你不记得了...
生活的意义到底是什么？
生活的意义在于享受乐趣 :D

文档：

堪察加的天气寒冷，冬季漫长而严酷。
意大利以意大利面、披萨、冰淇淋和浓缩咖啡而闻名。
我无法回忆个人姓名，只能提供信息。
生活的目的各不相同，通常被视为个人实现。
享受生活的时刻确实是一种美妙的方式。

截断

嵌入模型通常具有固定的上下文窗口，该窗口决定了可以嵌入的最大输入令牌数。这个限制可能是硬限制，等于模型的最大输入令牌长度，也可能是有效限制，超过该限制后嵌入的准确性会降低。

由于模型操作的是令牌，而应用程序通常处理的是文本，因此应用程序确保其输入保持在模型的令牌限制内可能具有挑战性。默认情况下，如果输入过大，则会抛出异常。

为了帮助解决这个问题，NVIDIA的NIMs（API目录或本地）提供了一个truncate参数，如果输入过大，它会在服务器端截断输入。

truncate 参数有三个选项：

"NONE": 默认选项。如果输入过大，将抛出异常。
"START": 服务器从开始（左侧）截断输入，根据需要丢弃令牌。
"END": 服务器从末尾（右侧）截断输入，根据需要丢弃令牌。

long_text = "AI is amazing, amazing is " * 100

strict_embedder = NVIDIAEmbeddings()
try:
    strict_embedder.embed_query(long_text)
except Exception as e:
    print("Error:", e)

truncating_embedder = NVIDIAEmbeddings(truncate="END")
truncating_embedder.embed_query(long_text)[:5]

RAG 检索:

以下是LangChain 表达式语言检索手册条目初始示例的重新利用，但使用了AI基础模型的Mixtral 8x7B Instruct和NVIDIA Retrieval QA Embedding模型在其游乐场环境中执行。手册中的后续示例也按预期运行，我们鼓励您使用这些选项进行探索。

提示：我们建议使用Mixtral进行内部推理（即遵循指令进行数据提取、工具选择等），并使用Llama-Chat进行最终的“根据历史和上下文为用户生成一个简单的总结性响应”响应。

%pip install --upgrade --quiet  langchain faiss-cpu tiktoken langchain_community

from operator import itemgetter

from langchain_community.vectorstores import FAISS
from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough
from langchain_nvidia_ai_endpoints import ChatNVIDIA

API Reference:FAISS | StrOutputParser | ChatPromptTemplate | RunnablePassthrough | ChatNVIDIA

vectorstore = FAISS.from_texts(
    ["harrison worked at kensho"],
    embedding=NVIDIAEmbeddings(model="NV-Embed-QA"),
)
retriever = vectorstore.as_retriever()

prompt = ChatPromptTemplate.from_messages(
    [
        (
            "system",
            "Answer solely based on the following context:\n<Documents>\n{context}\n</Documents>",
        ),
        ("user", "{question}"),
    ]
)

model = ChatNVIDIA(model="ai-mixtral-8x7b-instruct")

chain = (
    {"context": retriever, "question": RunnablePassthrough()}
    | prompt
    | model
    | StrOutputParser()
)

chain.invoke("where did harrison work?")

prompt = ChatPromptTemplate.from_messages(
    [
        (
            "system",
            "Answer using information solely based on the following context:\n<Documents>\n{context}\n</Documents>"
            "\nSpeak only in the following language: {language}",
        ),
        ("user", "{question}"),
    ]
)

chain = (
    {
        "context": itemgetter("question") | retriever,
        "question": itemgetter("question"),
        "language": itemgetter("language"),
    }
    | prompt
    | model
    | StrOutputParser()
)

chain.invoke({"question": "where did harrison work", "language": "italian"})

嵌入模型概念指南
嵌入模型操作指南

安装​

设置​

在NVIDIA API目录中使用NIMs​

使用自托管的NVIDIA NIMs​

相似性​

嵌入运行时​

文档嵌入​

截断​

RAG 检索:​

相关​

这个页面有帮助吗？

安装

设置

在NVIDIA API目录中使用NIMs

使用自托管的NVIDIA NIMs

相似性

嵌入运行时

文档嵌入

截断

RAG 检索:

相关