ChatPremAI
PremAI 是一个一体化平台，简化了由生成式 AI 驱动的强大、可投入生产的应用程序的创建。通过简化开发流程，PremAI 使您能够专注于提升用户体验并推动应用程序的整体增长。您可以在 这里 快速开始使用我们的平台。
此示例介绍了如何使用 LangChain 与使用 ChatPremAI 的不同聊天模型进行交互。
安装和设置
我们首先安装 langchain 和 premai-sdk。您可以键入以下命令进行安装
pip install premai langchain
在继续之前，请确保您已在 PremAI 上创建帐户并已创建项目。如果没有，请参阅 快速入门 指南，开始使用 PremAI 平台。创建您的第一个项目并获取您的 API 密钥。
from langchain_community.chat_models import ChatPremAI
from langchain_core.messages import HumanMessage, SystemMessage
在 LangChain 中设置 PremAI 客户端
导入完所需模块后，我们来设置客户端。现在，假设我们的 project_id 是 8。但是，请确保您使用的是您的项目 ID，否则会引发错误。
要将 langchain 与 prem 一起使用，您不需要传递任何模型名称或设置任何参数来使用我们的聊天客户端。默认情况下，它将使用 LaunchPad 中使用的模型名称和参数。
注意：如果您在设置客户端时更改了
model或其他任何参数，例如temperature或max_tokens，它将覆盖 LaunchPad 中使用的现有默认配置。
import getpass
import os
# First step is to set up the env variable.
# you can also pass the API key while instantiating the model but this
# comes under a best practices to set it as env variable.
if os.environ.get("PREMAI_API_KEY") is None:
os.environ["PREMAI_API_KEY"] = getpass.getpass("PremAI API Key:")
# By default it will use the model which was deployed through the platform
# in my case it will is "gpt-4o"
chat = ChatPremAI(project_id=1234, model_name="gpt-4o")
聊天完成
ChatPremAI 支持两种方法：invoke（与 generate 相同）和 stream。
第一个将给我们一个静态结果。而第二个将逐个流式传输标记。以下是如何生成类似聊天的完成。
human_message = HumanMessage(content="Who are you?")
response = chat.invoke([human_message])
print(response.content)
I am an AI language model created by OpenAI, designed to assist with answering questions and providing information based on the context provided. How can I help you today?
上面看起来很有趣吧？我将我的默认启动板系统提示设置为：Always sound like a pirate 当然，如果您需要，也可以覆盖默认的系统提示。以下是如何操作。
system_message = SystemMessage(content="You are a friendly assistant.")
human_message = HumanMessage(content="Who are you?")
chat.invoke([system_message, human_message])
AIMessage(content="I'm your friendly assistant! How can I help you today?", response_metadata={'document_chunks': [{'repository_id': 1985, 'document_id': 1306, 'chunk_id': 173899, 'document_name': '[D] Difference between sparse and dense informati…', 'similarity_score': 0.3209080100059509, 'content': "with the difference or anywhere\nwhere I can read about it?\n\n\n 17 9\n\n\n u/ScotiabankCanada • Promoted\n\n\n Accelerate your study permit process\n with Scotiabank's Student GIC\n Program. We're here to help you tur…\n\n\n startright.scotiabank.com Learn More\n\n\n Add a Comment\n\n\nSort by: Best\n\n\n DinosParkour • 1y ago\n\n\n Dense Retrieval (DR) m"}]}, id='run-510bbd0e-3f8f-4095-9b1f-c2d29fd89719-0')
您可以在此处提供系统提示
chat.invoke([system_message, human_message], temperature=0.7, max_tokens=10, top_p=0.95)
/home/anindya/prem/langchain/libs/community/langchain_community/chat_models/premai.py:355: UserWarning: WARNING: Parameter top_p is not supported in kwargs.
warnings.warn(f"WARNING: Parameter {key} is not supported in kwargs.")
AIMessage(content="Hello! I'm your friendly assistant. How can I", response_metadata={'document_chunks': [{'repository_id': 1985, 'document_id': 1306, 'chunk_id': 173899, 'document_name': '[D] Difference between sparse and dense informati…', 'similarity_score': 0.3209080100059509, 'content': "with the difference or anywhere\nwhere I can read about it?\n\n\n 17 9\n\n\n u/ScotiabankCanada • Promoted\n\n\n Accelerate your study permit process\n with Scotiabank's Student GIC\n Program. We're here to help you tur…\n\n\n startright.scotiabank.com Learn More\n\n\n Add a Comment\n\n\nSort by: Best\n\n\n DinosParkour • 1y ago\n\n\n Dense Retrieval (DR) m"}]}, id='run-c4b06b98-4161-4cca-8495-fd2fc98fa8f8-0')
如果您要将系统提示放在此处，那么它将覆盖您从平台部署应用程序时固定的系统提示。
Prem 存储库的本机 RAG 支持
Prem 存储库允许用户上传文档（.txt、.pdf 等）并将这些存储库连接到 LLM。您可以将 Prem 存储库视为本机 RAG，其中每个存储库都可以视为一个向量数据库。您可以连接多个存储库。您可以 在此处 了解有关存储库的更多信息。
存储库也支持 langchain premai。以下是如何操作。
query = "Which models are used for dense retrieval"
repository_ids = [
1985,
]
repositories = dict(ids=repository_ids, similarity_threshold=0.3, limit=3)
首先，我们使用一些存储库 ID 定义我们的存储库。请确保这些 ID 是有效的存储库 ID。您可以 在此处 了解有关如何获取存储库 ID 的更多信息。
请注意：与
model_name类似，当您调用参数repositories时，您可能会覆盖在启动板中连接的存储库。
现在，我们将存储库与我们的聊天对象连接，以调用基于 RAG 的生成。
import json
response = chat.invoke(query, max_tokens=100, repositories=repositories)
print(response.content)
print(json.dumps(response.response_metadata, indent=4))
Dense retrieval models typically include:
1. **BERT-based Models**: Such as DPR (Dense Passage Retrieval) which uses BERT for encoding queries and passages.
2. **ColBERT**: A model that combines BERT with late interaction mechanisms.
3. **ANCE (Approximate Nearest Neighbor Negative Contrastive Estimation)**: Uses BERT and focuses on efficient retrieval.
4. **TCT-ColBERT**: A variant of ColBERT that uses a two-tower
{
"document_chunks": [
{
"repository_id": 1985,
"document_id": 1306,
"chunk_id": 173899,
"document_name": "[D] Difference between sparse and dense informati\u2026",
"similarity_score": 0.3209080100059509,
"content": "with the difference or anywhere\nwhere I can read about it?\n\n\n 17 9\n\n\n u/ScotiabankCanada \u2022 Promoted\n\n\n Accelerate your study permit process\n with Scotiabank's Student GIC\n Program. We're here to help you tur\u2026\n\n\n startright.scotiabank.com Learn More\n\n\n Add a Comment\n\n\nSort by: Best\n\n\n DinosParkour \u2022 1y ago\n\n\n Dense Retrieval (DR) m"
}
]
}
理想情况下，您不需要在此处连接存储库 ID 以获得检索增强生成。如果您已在 prem 平台中连接了存储库，您仍然可以获得相同的结果。
Prem 模板
编写提示模板可能非常混乱。提示模板很长、难以管理，并且必须不断调整以改进并保持在整个应用程序中保持一致。
使用 Prem，编写和管理提示变得非常容易。模板 选项卡位于 启动板 中，可帮助您编写所需的提示数量，并将其用于 SDK 中，使用这些提示使您的应用程序运行。您可以 在此处 阅读有关提示模板的更多信息。
要将 Prem 模板与 LangChain 原生结合使用，您需要在 HumanMessage 中传递一个 ID。此 ID 应为您的提示模板的变量名称。HumanMessage 中的 content 应为该变量的值。
例如，如果您的提示模板是以下内容
Say hello to my name and say a feel-good quote
from my age. My name is: {name} and age is {age}
因此，您的 human_messages 应如下所示
human_messages = [
HumanMessage(content="Shawn", id="name"),
HumanMessage(content="22", id="age"),
]
将此 human_messages 传递给 ChatPremAI 客户端。请注意：不要忘记传递附加的 template_id 来使用 Prem 模板调用生成。如果您不知道 template_id，您可以 在我们的文档中 了解有关它的更多信息。以下是一个示例
template_id = "78069ce8-xxxxx-xxxxx-xxxx-xxx"
response = chat.invoke([human_messages], template_id=template_id)
print(response.content)
Prem 模板功能也可用于流式传输。
流式传输
在本节中，让我们了解如何使用 langchain 和 PremAI 流式传输标记。以下是如何操作。
import sys
for chunk in chat.stream("hello how are you"):
sys.stdout.write(chunk.content)
sys.stdout.flush()
It looks like your message got cut off. If you need information about Dense Retrieval (DR) or any other topic, please provide more details or clarify your question.
与上面类似，如果您想覆盖系统提示和生成参数，则需要添加以下内容
import sys
# For some experimental reasons if you want to override the system prompt then you
# can pass that here too. However it is not recommended to override system prompt
# of an already deployed model.
for chunk in chat.stream(
"hello how are you",
system_prompt="act like a dog",
temperature=0.7,
max_tokens=200,
):
sys.stdout.write(chunk.content)
sys.stdout.flush()
Woof! 🐾 How can I help you today? Want to play fetch or maybe go for a walk 🐶🦴
工具/函数调用
LangChain PremAI 支持工具/函数调用。工具/函数调用允许模型通过生成与用户定义模式匹配的输出来响应给定的提示。
注意：LangChain ChatPremAI 的当前版本不支持使用流式传输功能/工具调用。流式传输支持以及函数调用功能将在不久后推出。
将工具传递给模型
为了传递工具并让 LLM 选择它需要调用的工具，我们需要传递一个工具模式。工具模式是函数定义以及有关函数的作用、函数的每个参数是什么等的适当文档字符串。以下是一些简单的算术函数及其模式。
注意：在定义函数/工具模式时，不要忘记添加有关函数参数的信息，否则会引发错误。
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.tools import tool
# Define the schema for function arguments
class OperationInput(BaseModel):
a: int = Field(description="First number")
b: int = Field(description="Second number")
# Now define the function where schema for argument will be OperationInput
@tool("add", args_schema=OperationInput, return_direct=True)
def add(a: int, b: int) -> int:
"""Adds a and b.
Args:
a: first int
b: second int
"""
return a + b
@tool("multiply", args_schema=OperationInput, return_direct=True)
def multiply(a: int, b: int) -> int:
"""Multiplies a and b.
Args:
a: first int
b: second int
"""
return a * b
将工具模式与我们的 LLM 绑定
我们现在将使用 bind_tools 方法将我们上面的函数转换为“工具”，并将其与模型绑定。这意味着每次调用模型时，我们都将传递这些工具信息。
tools = [add, multiply]
llm_with_tools = chat.bind_tools(tools)
之后，我们从与工具绑定的模型获取响应。
query = "What is 3 * 12? Also, what is 11 + 49?"
messages = [HumanMessage(query)]
ai_msg = llm_with_tools.invoke(messages)
正如我们所见，当我们的聊天模型与工具绑定时，它会根据给定的提示调用正确的工具集，并按顺序执行。
ai_msg.tool_calls
[{'name': 'multiply',
'args': {'a': 3, 'b': 12},
'id': 'call_A9FL20u12lz6TpOLaiS6rFa8'},
{'name': 'add',
'args': {'a': 11, 'b': 49},
'id': 'call_MPKYGLHbf39csJIyb5BZ9xIk'}]
我们将上面显示的此消息附加到 LLM，它充当上下文，使 LLM 了解它调用了哪些函数。
messages.append(ai_msg)
由于工具调用分为两个阶段，其中
在我们的第一个调用中，我们收集了 LLM 决定使用的所有工具，以便它可以获得结果作为附加的上下文，以提供更准确且无幻觉的结果。
在我们的第二个调用中，我们将解析 LLM 决定的工具集并运行它们（在我们的例子中，它将是我们定义的函数，以及 LLM 提取的参数），并将此结果传递给 LLM
from langchain_core.messages import ToolMessage
for tool_call in ai_msg.tool_calls:
selected_tool = {"add": add, "multiply": multiply}[tool_call["name"].lower()]
tool_output = selected_tool.invoke(tool_call["args"])
messages.append(ToolMessage(tool_output, tool_call_id=tool_call["id"]))
最后，我们调用与工具绑定的 LLM，并将函数响应添加到其上下文中。
response = llm_with_tools.invoke(messages)
print(response.content)
The final answers are:
- 3 * 12 = 36
- 11 + 49 = 60
定义工具模式：Pydantic 类
上面我们展示了如何使用 tool 装饰器定义模式，但我们也可以使用 Pydantic 来等效地定义模式。当你的工具输入更复杂时，Pydantic 会很有用
from langchain_core.output_parsers.openai_tools import PydanticToolsParser
class add(BaseModel):
"""Add two integers together."""
a: int = Field(..., description="First integer")
b: int = Field(..., description="Second integer")
class multiply(BaseModel):
"""Multiply two integers together."""
a: int = Field(..., description="First integer")
b: int = Field(..., description="Second integer")
tools = [add, multiply]
现在，我们可以将它们绑定到聊天模型并直接获取结果
chain = llm_with_tools | PydanticToolsParser(tools=[multiply, add])
chain.invoke(query)
[multiply(a=3, b=12), add(a=11, b=49)]
现在，如上所述，我们解析并运行这些函数，并再次调用 LLM 以获取结果。