Skip to main content
llama.cpp python 库是 @ggerganov 的 llama.cpp 的简单 Python 绑定。 此包提供：
  • 通过 ctypes 接口对 C API 的低级访问。
  • 用于文本补全的高级 Python API
    • 类似 OpenAI 的 API
    • LangChain 兼容性
    • LlamaIndex 兼容性
  • OpenAI 兼容的 Web 服务器
    • 本地 Copilot 替代方案
    • 支持函数调用
    • 支持视觉 API
    • 多模型支持

​
概述

​
集成详情

类包可序列化JS 支持
ChatLlamaCpplangchain-community❌❌

​
模型特性

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

​
设置

要开始使用并体验下面展示的所有功能，我们建议使用一个针对工具调用进行过微调的模型。 我们将使用来自 NousResearch 的 Hermes-2-Pro-Llama-3-8B-GGUF。
Hermes 2 Pro 是 Nous Hermes 2 的升级版，包含更新和清理过的 OpenHermes 2.5 数据集，以及新引入的内部开发的函数调用和 JSON 模式数据集。这个新版本的 Hermes 保持了其出色的通用任务和对话能力，同时在函数调用方面也表现出色。
请参阅我们关于本地模型的指南以深入了解：

​
安装

LangChain 的 LlamaCpp 集成位于 langchain-community 和 llama-cpp-python 包中： 
pip install -qU langchain-community llama-cpp-python

​
实例化

现在我们可以实例化我们的模型对象并生成聊天补全： 
# 你的模型权重路径
local_model = "local/path/to/Hermes-2-Pro-Llama-3-8B-Q8_0.gguf"

import multiprocessing

from langchain_community.chat_models import ChatLlamaCpp

llm = ChatLlamaCpp(
    temperature=0.5,
    model_path=local_model,
    n_ctx=10000,
    n_gpu_layers=8,
    n_batch=300,  # 应在 1 到 n_ctx 之间，考虑你 GPU 的 VRAM 容量。
    max_tokens=512,
    n_threads=multiprocessing.cpu_count() - 1,
    repeat_penalty=1.5,
    top_p=0.5,
    verbose=True,
)

​
调用

messages = [
    (
        "system",
        "你是一个将英语翻译成法语的助手。翻译用户的句子。",
    ),
    ("human", "I love programming."),
]

ai_msg = llm.invoke(messages)
ai_msg

print(ai_msg.content)

J'aime programmer. (在法国，"programming" 通常保留其原意，指安排或组织活动。)

如果你指的是计算机编程：
Je suis amoureux de la programmation informatique.

(你也可以简单地说 'programmation'，根据上下文，这可以理解为两种意思)。

​
工具调用

首先，它的工作方式与 OpenAI 函数调用基本相同。 OpenAI 有一个工具调用（我们在这里交替使用“工具调用”和“函数调用”）API，允许你描述工具及其参数，并让模型返回一个 JSON 对象，其中包含要调用的工具和该工具的输入。工具调用对于构建使用工具的链和代理，以及更一般地从模型获取结构化输出非常有用。 通过 ChatLlamaCpp.bind_tools，我们可以轻松地将 Pydantic 类、字典模式、LangChain 工具，甚至函数作为工具传递给模型。在底层，这些被转换为 OpenAI 工具模式，看起来像： 
{
    "name": "...",
    "description": "...",
    "parameters": {...}  # JSONSchema
}
并在每次模型调用中传递。 但是，它不能自动触发函数/工具，我们需要通过指定 ‘tool_choice’ 参数来强制它。这个参数通常按以下格式描述。 {"type": "function", "function": {"name": <<tool_name>>}}. 
from langchain.tools import tool
from pydantic import BaseModel, Field


class WeatherInput(BaseModel):
        location: str = Field(description="城市和州，例如：San Francisco, CA")
        unit: str = Field(enum=["celsius", "fahrenheit"])


@tool("get_current_weather", args_schema=WeatherInput)
def get_weather(location: str, unit: str):
    """获取指定地点的当前天气"""
    return f"现在 {location} 的天气是 22 {unit}"


llm_with_tools = llm.bind_tools(
        tools=[get_weather],
        tool_choice={"type": "function", "function": {"name": "get_current_weather"}},
)

ai_msg = llm_with_tools.invoke(
    "胡志明市的天气怎么样，用摄氏度表示",
)

ai_msg.tool_calls

[{'name': 'get_current_weather',
  'args': {'location': 'Ho Chi Minh City', 'unit': 'celsius'},
  'id': 'call__0_get_current_weather_cmpl-394d9943-0a1f-425b-8139-d2826c1431f2'}]

class MagicFunctionInput(BaseModel):
        magic_function_input: int = Field(description="魔法函数的输入值")


@tool("get_magic_function", args_schema=MagicFunctionInput)
def magic_function(magic_function_input: int):
    """获取输入值的魔法函数结果。"""
    return magic_function_input + 2


llm_with_tools = llm.bind_tools(
        tools=[magic_function],
        tool_choice={"type": "function", "function": {"name": "get_magic_function"}},
)

ai_msg = llm_with_tools.invoke(
    "3 的魔法函数值是多少？",
)

ai_msg

ai_msg.tool_calls

[{'name': 'get_magic_function',
  'args': {'magic_function_input': 3},
  'id': 'call__0_get_magic_function_cmpl-cd83a994-b820-4428-957c-48076c68335a'}]

​
结构化输出

from langchain_core.utils.function_calling import convert_to_openai_tool
from pydantic import BaseModel


class Joke(BaseModel):
    """笑话的铺垫和笑点。"""

    setup: str
    punchline: str


dict_schema = convert_to_openai_tool(Joke)
structured_llm = llm.with_structured_output(dict_schema)
result = structured_llm.invoke("给我讲一个关于鸟的笑话")
result

result

{'setup': '- 为什么小鸡要穿过操场？',
 'punchline': '\n\n- 为了到另一边的镀金笼子里去！'}

​
流式传输

for chunk in llm.stream("25x5 等于多少"):
        print(chunk.content, end="\n", flush=True)
Edit this page on GitHub or file an issue.
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.