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

​
概述

​
集成详情

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

​
模型功能

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

​
设置

为了开始使用并体验以下所有功能，我们建议使用经过工具调用微调的模型。 我们将使用 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

​
实例化

现在我们可以实例化模型对象并生成聊天补全： 
# Path to your model weights
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,  # Should be between 1 and n_ctx, consider the amount of VRAM in your GPU.
    max_tokens=512,
    n_threads=multiprocessing.cpu_count() - 1,
    repeat_penalty=1.5,
    top_p=0.5,
    verbose=True,
)

​
调用

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)

J'aime programmer. (In France, "programming" is often used in its original sense of scheduling or organizing events.)

If you meant computer-programming:
Je suis amoureux de la programmation informatique.

(You might also say simply 'programmation', which would be understood as both meanings - depending on context).

​
工具调用

首先，其用法与 OpenAI 函数调用大体相同。 OpenAI 提供了工具调用 API（我们在此将”工具调用”和”函数调用”互换使用），该 API 允许您描述工具及其参数，并让模型返回一个 JSON 对象，包含要调用的工具以及该工具的输入。工具调用对于构建使用工具的链和 Agent 极其有用，也能更普遍地从模型获取结构化输出。 通过 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="The city and state, e.g. San Francisco, CA")
        unit: str = Field(enum=["celsius", "fahrenheit"])


@tool("get_current_weather", args_schema=WeatherInput)
def get_weather(location: str, unit: str):
    """Get the current weather in a given location"""
    return f"Now the weather in {location} is 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(
    "what is the weather like in HCMC in celsius",
)

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="The input value for magic function")


@tool("get_magic_function", args_schema=MagicFunctionInput)
def magic_function(magic_function_input: int):
    """Get the value of magic function for an input."""
    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(
    "What is magic function of 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):
    """A setup to a joke and the punchline."""

    setup: str
    punchline: str


dict_schema = convert_to_openai_tool(Joke)
structured_llm = llm.with_structured_output(dict_schema)
result = structured_llm.invoke("Tell me a joke about birds")
result

result

{'setup': '- Why did the chicken cross the playground?',
 'punchline': '\n\n- To get to its gilded cage on the other side!'}

​
流式输出

for chunk in llm.stream("what is 25x5"):
        print(chunk.content, end="\n", flush=True)

​
API 参考

有关 ChatLlamaCpp 所有功能和配置的详细文档，请前往 API 参考：python.langchain.com/api_reference/community/chat_models/langchain_community.chat_models.llamacpp.ChatLlamaCpp.html
在 GitHub 上编辑此页面 或 提交问题。
将这些文档连接到 Claude、VSCode 等，通过 MCP 获取实时解答。