Chat Writer

此笔记本提供了一个快速概览，帮助您开始使用 Writer 聊天。

Writer 有多种聊天模型。您可以在 Writer 文档中找到关于其最新模型及其成本、上下文窗口和支持的输入类型的信息。

概述

集成详情

类	包	本地	可序列化	JS 支持	包下载量	包最新版本
ChatWriter	langchain-writer	❌	❌	❌

模型功能

工具调用	结构化输出	JSON 模式	图像输入	音频输入	视频输入	令牌级流式传输	原生异步	令牌使用量	Logprobs
✅	❌	❌	❌	❌	❌	✅	✅	✅	❌

凭据

注册 Writer AI Studio 并按照此快速入门获取 API 密钥。然后，设置 WRITER_API_KEY 环境变量

import getpass
import os

if not os.getenv("WRITER_API_KEY"):
    os.environ["WRITER_API_KEY"] = getpass.getpass("Enter your Writer API key: ")

如果您想获得模型调用的自动跟踪，您还可以通过取消注释下方内容来设置您的 LangSmith API 密钥

# os.environ["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安装

ChatWriter 可从 langchain-writer 包中获得。使用以下命令安装它

%pip install -qU langchain-writer

实例化

现在我们可以实例化我们的模型对象以生成聊天完成

from langchain_writer import ChatWriter

llm = ChatWriter(
    model="palmyra-x-004",
    temperature=0,
    max_tokens=None,
    timeout=None,
    max_retries=2,
)

用法

要使用该模型，您需要传入消息列表并调用 invoke 方法

messages = [
    (
        "system",
        "You are a helpful assistant that translates English to French. Translate the user sentence.",
    ),
    ("human", "I love programming."),
]
ai_msg = llm.invoke(messages)
ai_msg

然后，您可以访问消息的内容

print(ai_msg.content)

流式传输

您还可以流式传输响应。首先，创建一个流

messages = [
    (
        "system",
        "You are a helpful assistant that translates English to French. Translate the user sentence.",
    ),
    ("human", "I love programming. Sing a song about it"),
]
ai_stream = llm.stream(messages)
ai_stream

然后，遍历流以获取块

for chunk in ai_stream:
    print(chunk.content, end="")

工具调用

Writer 模型（如 Palmyra X 004）支持工具调用，这使您可以描述工具及其参数。该模型将返回一个 JSON 对象，其中包含要调用的工具和该工具的输入。

绑定工具

使用 ChatWriter.bind_tools，您可以轻松地将 Pydantic 类、字典模式、LangChain 工具甚至函数作为工具传递给模型。在幕后，这些工具被转换为工具模式，如下所示

{
    "name": "...",
    "description": "...",
    "parameters": {...}  # JSONSchema
}

这些工具模式在每次模型调用中都会传入。

例如，要使用获取给定位置天气的工具，您可以定义一个 Pydantic 类并将其传递给 ChatWriter.bind_tools

from pydantic import BaseModel, Field


class GetWeather(BaseModel):
    """Get the current weather in a given location"""

    location: str = Field(..., description="The city and state, e.g. San Francisco, CA")


llm.bind_tools([GetWeather])

然后，您可以使用该工具调用模型

ai_msg = llm.invoke(
    "what is the weather like in New York City",
)
ai_msg

最后，您可以访问工具调用并继续执行您的函数

print(ai_msg.tool_calls)

关于工具绑定的注意事项

ChatWriter.bind_tools() 方法不会创建绑定工具的新实例，而是在初始类实例属性中存储接收到的 tools 和 tool_choice，以便在使用 ChatWriter 调用时将它们作为参数传递给 Palmyra LLM 调用。这种方法允许支持不同的工具类型，例如 function 和 graph。Graph 是远程调用的 Writer Palmyra 工具之一。有关更多信息，请访问我们的文档。

有关 LangChain 中工具使用的更多信息，请访问 LangChain 工具调用文档。

批量处理

您还可以批量处理请求并设置 max_concurrency

ai_batch = llm.batch(
    [
        "How to cook pancakes?",
        "How to compose poem?",
        "How to run faster?",
    ],
    config={"max_concurrency": 3},
)
ai_batch

然后，遍历批次以获取结果

for batch in ai_batch:
    print(batch.content)
    print("-" * 100)

异步用法

以上所有功能（调用、流式传输、批量处理、工具调用）也支持异步用法。

提示模板

提示模板 帮助将用户输入和参数转换为语言模型的指令。您可以像这样将 ChatWriter 与提示模板一起使用

from langchain_core.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate(
    [
        (
            "system",
            "You are a helpful assistant that translates {input_language} to {output_language}.",
        ),
        ("human", "{input}"),
    ]
)

chain = prompt | llm
chain.invoke(
    {
        "input_language": "English",
        "output_language": "German",
        "input": "I love programming.",
    }
)

API 参考：ChatPromptTemplate

API 参考

有关所有 ChatWriter 功能和配置的详细文档，请访问 API 参考。

其他资源

您可以在 Writer 文档中找到关于 Writer 模型（包括成本、上下文窗口和支持的输入类型）和工具的信息。

相关内容

• 聊天模型概念指南
• 聊天模型操作指南