Ollama API 介绍 – wiki基地


本地大模型的新篇章:深入解析 Ollama API

随着大语言模型(LLM)技术的飞速发展,将AI能力集成到各类应用中已成为主流趋势。然而,许多强大的LLM运行在云端,这带来了成本、隐私和数据主权等方面的考量。在这种背景下,Ollama 应运而生,它是一个旨在简化在本地计算机上运行和管理大型语言模型的工具。Ollama 提供了一个易于使用的命令行界面(CLI),以及一个便捷的API接口,使得开发者能够轻松地在其应用中利用本地运行的LLM。

本文将深入探讨 Ollama API 的方方面面,包括其设计理念、核心功能、常用接口、高级特性以及如何利用它来构建强大的本地AI应用。无论你是希望在离线环境中运行AI、保护敏感数据,还是仅仅想更经济高效地利用LLM,Ollama API 都为你提供了强大的工具。

第一部分:Ollama 是什么?为何需要其API?

在深入API细节之前,我们先简要回顾一下 Ollama 的定位。Ollama 是一个开源项目,它打包了运行各种开源大模型的必要组件(模型权重、运行时、量化库等),并提供统一的接口。通过 Ollama,你可以在你的Linux、macOS 或 Windows 机器上轻松下载、安装和运行如 Llama 2, Mistral, Code Llama, Yi, Qwen 等众多流行的开源模型,通常只需要一条简单的命令。

Ollama 的核心优势在于其易用性和对本地运行的优化。它抽象了底层运行模型的复杂性,例如CUDA/GPU加速、模型格式转换等,让用户能够快速启动并与模型交互。

然而,对于开发者而言,仅仅有一个 CLI 或桌面应用是不够的。要将 Ollama 的能力整合到更复杂的软件系统中,例如:

  • 构建一个自定义的聊天机器人界面。
  • 开发一个能够对本地文档进行问答的 RAG (Retrieval Augmented Generation) 系统。
  • 创建一个代码自动补全或审查工具。
  • 构建一个离线的数据分析或内容生成应用。

这就需要一个编程接口。Ollama API 正是为此而生。它将 Ollama 的核心功能——运行模型进行文本生成、生成文本向量(embeddings)、管理模型等——通过标准的 HTTP RESTful API 暴露出来。这意味着任何支持HTTP请求的编程语言或工具链都可以轻松地与本地运行的 Ollama 服务进行交互,从而构建出无限可能的AI应用。

使用 Ollama API 的主要优势包括:

  1. 本地执行与数据隐私: 所有计算都在本地完成,敏感数据无需上传到云端,极大地增强了隐私和安全性。
  2. 成本效益: 避免了按使用量付费的云端API费用,只需承担本地硬件的成本。
  3. 低延迟: 由于模型在本地运行,通常可以获得比远程API更低的延迟(取决于本地硬件性能)。
  4. 离线能力: 应用可以在没有互联网连接的情况下运行(一旦模型下载完成)。
  5. 模型多样性与灵活性: 可以轻松切换和管理不同大小、不同类型的模型,甚至通过 Modelfile 创建自定义模型。
  6. 易于集成: 标准的HTTP API使得与现有应用和服务集成变得非常直接。

第二部分:Ollama API 基础

Ollama 服务启动后,默认会在 http://localhost:11434 监听请求(端口可配置)。API 端点都以 /api/ 开头。请求和响应通常使用 JSON 格式进行数据交换。

要开始使用 API,首先需要:

  1. 安装 Ollama: 访问 Ollama 官网 (ollama.com) 下载并安装对应操作系统的版本。
  2. 运行 Ollama 服务: 安装完成后,Ollama 服务通常会自动在后台启动。你也可以通过命令行运行 ollama start 来启动服务。
  3. 下载模型: 在使用 API 调用某个模型之前,需要确保该模型已经在本地下载。可以通过 CLI 命令 ollama run <model_name> 来下载并运行一次模型,或者使用 API 来拉取模型。例如,下载 Llama 2 7B 模型:ollama run llama2

一旦服务启动并下载了模型,就可以通过 HTTP 请求与 API 进行交互了。

第三部分:核心 API 端点详解

Ollama API 提供了多个端点来覆盖模型运行和管理的不同方面。以下是一些最常用和最重要的端点:

1. 生成文本 (Generate Completions)

这是最核心的 API 端点,用于让模型根据给定的提示(prompt)生成文本。

  • URL: /api/generate
  • Method: POST
  • 请求体 (Request Body): JSON 对象,包含以下主要字段:

    • model (字符串, 必需): 要使用的模型名称(例如 "llama2")。
    • prompt (字符串, 必需): 发送给模型的提示文本。
    • system (字符串, 可选): 设置模型的系统提示,影响模型的整体行为风格。类似于 OpenAI API 的 system message。
    • template (字符串, 可选): 自定义提示模板。如果你了解模型期望的输入格式(如聊天格式),可以使用此字段覆盖默认模板。
    • context (数组, 可选): 用于维护对话历史的状态。在连续的对话轮次中,将前一个响应中返回的 context 值包含在此字段中。
    • stream (布尔值, 可选): 如果设置为 true,响应将以流式方式返回,每次返回部分生成的文本;如果设置为 false,将等待生成完成后一次性返回完整结果。默认值为 true
    • options (对象, 可选): 控制生成行为的参数集合。这是 Ollama API 灵活性所在,可以微调模型的输出。常见参数包括:
      • temperature (浮点数): 控制生成文本的随机性。值越高越随机(有创造力),值越低越确定。通常在 0 到 2 之间。
      • top_k (整数): 采样时考虑概率最高的 k 个 token。值越低,模型越倾向于选择最高概率的词,生成更确定。
      • top_p (浮点数): 使用核采样(nucleus sampling),只考虑累积概率达到 p 的最高概率 token 集合。结合 top_k 使用,提供更精细的控制。
      • num_predict (整数): 限制生成的最大 token 数量。
      • stop (字符串或字符串数组): 指定一个或多个停止序列。当模型生成遇到这些序列时,会停止生成。
      • repeat_penalty (浮点数): 用于惩罚重复的 token,鼓励生成更多样化的文本。
      • tfs_z (浮点数): Tail Free Sampling 参数。
      • mirostat (整数): Mirostat 采样模式 (0, 1, 2)。
      • mirostat_eta (浮点数): Mirostat 学习率。
      • mirostat_tau (浮点数): Mirostat 目标熵。
      • num_ctx (整数): 模型处理的上下文长度。
      • num_gqa (整数): Grouped-query attention groups.
      • num_gpu (整数): 使用的 GPU 层数。
      • main_gpu (整数): 主 GPU 索引。
      • low_vram (布尔值): 启用低显存模式。
      • num_thread (整数): 使用的 CPU 线程数。
      • seed (整数): 生成的随机种子,用于复现结果。
      • … (还有其他一些不常用或实验性参数)
  • 响应体 (Response Body):

    • 流式 (stream: true): 响应是一个序列的 JSON 对象,每个对象代表生成过程中的一部分结果。每个 JSON 对象包含:
      • model (字符串): 使用的模型名称。
      • created_at (字符串): 生成时间戳。
      • response (字符串): 生成的文本片段。
      • done (布尔值): 如果为 true,表示生成已完成,这是最后一个对象。
      • context (数组): 只有在最后一个对象中出现,表示当前的上下文状态,用于下一轮对话。
      • total_duration (整数): 总耗时(纳秒)。
      • load_duration (整数): 模型加载耗时(纳秒)。
      • prompt_eval_count (整数): 提示中的 token 数量。
      • prompt_eval_duration (整数): 提示评估耗时(纳秒)。
      • eval_count (整数): 生成的 token 数量。
      • eval_duration (整数): 生成耗时(纳秒)。
    • 非流式 (stream: false): 响应是一个包含完整结果的 JSON 对象:
      • model (字符串): 使用的模型名称。
      • created_at (字符串): 生成时间戳。
      • response (字符串): 生成的完整文本。
      • done (布尔值): 总是 true
      • context (数组): 当前的上下文状态。
      • total_duration, load_duration, prompt_eval_count, prompt_eval_duration, eval_count, eval_duration: 与流式响应最后一个对象中的含义相同。

示例 (使用 curl 非流式请求):

bash
curl http://localhost:11434/api/generate -d '{
"model": "llama2",
"prompt": "为什么天空是蓝色的?",
"stream": false,
"options": {
"temperature": 0.7,
"num_predict": 100
}
}'

示例 (使用 curl 流式请求):

bash
curl http://localhost:11434/api/generate -d '{
"model": "llama2",
"prompt": "讲一个短故事。",
"stream": true
}'

流式响应将看起来像这样(简化):

json
{"model":"llama2","created_at":"...","response":"从前","done":false}
{"model":"llama2","created_at":"...","response":",有","done":false}
{"model":"llama2","created_at":"...","response":"一个","done":false}
...
{"model":"llama2","created_at":"...","response":"小村庄。","done":false}
{"model":"llama2","created_at":"...","response":"","done":true,"context":[...], "total_duration":...}

2. 生成向量 (Generate Embeddings)

此端点用于将文本转换成固定长度的数值向量(embeddings)。文本向量在许多AI应用中非常有用,特别是信息检索、文本相似度计算和 RAG 系统中。

  • URL: /api/embeddings
  • Method: POST
  • 请求体 (Request Body): JSON 对象,包含:

    • model (字符串, 必需): 用于生成 embedding 的模型名称。注意,并非所有模型都适用于生成高质量的 embedding。Ollama 推荐使用专门用于 embedding 的模型,例如 nomic-embed-text 或经过优化的通用模型。
    • prompt (字符串, 必需): 需要生成 embedding 的文本。
    • options (对象, 可选): 与 /api/generate 类似的参数,但对 embedding 生成影响较小,通常不需要设置。
  • 响应体 (Response Body): JSON 对象,包含:

    • embedding (数值数组): 生成的文本向量。

示例 (使用 curl):

bash
curl http://localhost:11434/api/embeddings -d '{
"model": "nomic-embed-text",
"prompt": "人工智能的未来"
}'

响应示例:

json
{
"embedding": [
-0.0685868307947,
0.0123456789,
... (一系列浮点数)
0.0987654321
]
}

3. 模型管理 API

Ollama API 还提供了一系列端点来管理本地的模型。

  • 列出本地模型 (List Local Models): 获取所有已下载到本地的模型列表。

    • URL: /api/tags
    • Method: GET
    • 请求体:
    • 响应体: JSON 对象,包含一个 models 数组。每个元素是一个模型对象,包含 name, modified_at, size, digest 等信息。

    示例 (使用 curl):
    bash
    curl http://localhost:11434/api/tags

  • 拉取模型 (Pull Model): 从 Ollama Hub 或指定注册表下载模型。

    • URL: /api/pull
    • Method: POST
    • 请求体: JSON 对象,包含 name (模型名称, 必需), insecure (布尔值, 可选,允许不安全的 TLS 连接), stream (布尔值, 可选,是否流式返回进度,默认为 false)。
    • 响应体: 根据 stream 参数,返回 JSON 流(包含状态信息)或最终完成状态。

    示例 (使用 curl 流式拉取):
    bash
    curl http://localhost:11434/api/pull -d '{
    "name": "mistral",
    "stream": true
    }'

  • 推送模型 (Push Model): 将本地创建或修改的模型推送到 Ollama Hub 或指定注册表。

    • URL: /api/push
    • Method: POST
    • 请求体: JSON 对象,包含 name (模型名称, 必需), insecure (布尔值, 可选), stream (布尔值, 可选)。
    • 响应体: 根据 stream 参数,返回 JSON 流(包含状态信息)或最终完成状态。

    示例 (使用 curl 流式推送):
    bash
    curl http://localhost:11434/api/push -d '{
    "name": "my-custom-model",
    "stream": true
    }'

  • 删除模型 (Delete Model): 从本地文件系统中删除指定模型。

    • URL: /api/delete
    • Method: DELETE
    • 请求体: JSON 对象,包含 name (模型名称, 必需)。
    • 响应体: 空响应(成功时)。

    示例 (使用 curl):
    bash
    curl http://localhost:11434/api/delete -X DELETE -d '{
    "name": "llama2:latest"
    }'

  • 创建模型 (Create Model): 使用 Modelfile 创建一个新模型。Modelfile 允许你基于现有模型、导入权重、设置参数、添加 system 提示等来定制模型。

    • URL: /api/create
    • Method: POST
    • 请求体: JSON 对象,包含 name (模型名称, 必需), modelfile (Modelfile 内容字符串, 必需), stream (布尔值, 可选)。
    • 响应体: 根据 stream 参数,返回 JSON 流(包含状态信息)或最终完成状态。

    Modelfile 示例:

    “`dockerfile

    基于 llama2 模型

    FROM llama2

    设置系统提示

    SYSTEM 您是一位热情友好的AI助手,请用中文回答所有问题。

    设置参数

    PARAMETER temperature 0.8
    PARAMETER top_k 40
    “`

    API 请求示例 (使用 curl 流式创建):

    bash
    curl http://localhost:11434/api/create -d '{
    "name": "my-chinese-assistant",
    "modelfile": "FROM llama2\nSYSTEM 您是一位热情友好的AI助手,请用中文回答所有问题。\nPARAMETER temperature 0.8",
    "stream": true
    }'

    这个端点非常强大,它允许你完全定制模型的行为。你可以在 Modelfile 中指定模型的源(可以是本地文件路径或远程URL),设置各种参数,甚至通过 ADAPTER 指令集成 LoRA 微调模型。

  • 显示模型信息 (Show Model Information): 获取指定模型的详细信息,包括 Modelfile 内容、参数、模板等。

    • URL: /api/show
    • Method: POST
    • 请求体: JSON 对象,包含 name (模型名称, 必需)。
    • 响应体: JSON 对象,包含模型的各种详细配置信息。

    示例 (使用 curl):
    bash
    curl http://localhost:11434/api/show -d '{
    "name": "my-chinese-assistant"
    }'

  • 复制模型 (Copy Model): 复制一个现有模型并赋予新名称。

    • URL: /api/copy
    • Method: POST
    • 请求体: JSON 对象,包含 source (源模型名称, 必需), destination (目标模型名称, 必需)。
    • 响应体: 空响应(成功时)。

    示例 (使用 curl):
    bash
    curl http://localhost:11434/api/copy -d '{
    "source": "llama2",
    "destination": "llama2-backup"
    }'

第四部分:API 高级概念

除了基本的请求-响应模式,Ollama API 还支持一些重要的概念,以便更好地进行交互和构建应用。

1. 流式响应 (Streaming)

流式响应对于生成文本来说至关重要,因为它允许应用实时地显示模型生成的文本,而不是等待整个生成过程完成。这提供了更好的用户体验,尤其是在生成长文本时。

如前所述,通过在 /api/generate/api/pull/api/create 请求中设置 "stream": true 来启用流式传输。API 会以 Server-Sent Events (SSE) 或类似的逐行 JSON 格式发送数据。客户端需要能够读取和解析这些连续的 JSON 对象。

每个流对象都包含一个小的响应片段或状态更新,直到 done 字段为 true,表示流结束。

2. 对话上下文 (Context)

语言模型本质上是无状态的,它们一次只处理当前的输入。为了进行有意义的多轮对话,应用程序需要自己管理对话历史,并在每次请求时将相关的历史信息或摘要提供给模型。

Ollama API 通过 context 字段简化了这一过程。在流式或非流式生成响应的最后一个 JSON 对象中,会包含一个 context 字段,它是一个整数数组,代表了当前对话的内部状态。在进行下一轮对话请求时,将这个 context 数组包含在请求体的 context 字段中,Ollama 服务就能利用这个状态信息,让模型“记住”之前的对话内容,从而实现连贯的多轮交流。

示例流程:
1. 发送第一个 /api/generate 请求,不包含 context
2. 接收到响应,提取最后一个对象中的 context 数组。
3. 发送第二个 /api/generate 请求,包含新的 prompt 和上一步提取的 context 数组。
4. 重复步骤 2 和 3。

这样,Ollama 服务负责将这个 context 数组以及当前的 prompt 结合起来,构建出完整的输入(包括历史)提供给模型。

3. 参数调优 (options)

/api/generate 请求中的 options 对象提供了对模型生成过程进行细粒度控制的能力。理解并利用这些参数是获得理想输出的关键:

  • temperature: 最常用的参数,控制随机性。调试时可以先设为0,确保模型给出最“确定”的答案,再逐渐提高以增加创意或多样性。
  • top_k, top_p: 控制采样空间。与 temperature 结合使用,影响生成文本的可预测性和多样性。
  • num_predict: 限制生成长度,防止模型无限生成。
  • stop: 定义停止词,用于控制生成何时结束,例如在生成代码时遇到特定的结束标记。

不同的模型和任务可能需要不同的参数设置,通常需要一些实验来找到最佳组合。

4. Modelfile 与模型定制

/api/create 端点使用的 Modelfile 是 Ollama API 提供的一个强大定制功能。Modelfile 语法类似于 Dockerfile,允许你:

  • FROM: 指定一个基础模型(可以是 Ollama Hub 上的模型,也可以是本地文件路径)。
  • PARAMETER: 设置模型的各种运行参数(与 /api/generate 中的 options 大部分对应)。这些参数将被 baked 到模型定义中。
  • SYSTEM: 设置模型的默认系统提示。
  • TEMPLATE: 设置模型的默认提示模板。
  • ADAPTER: 加载 LoRA 微调模型(指向适配器文件的路径)。
  • LICENSE: 包含模型的许可证信息。
  • MESSAGE: 为模型添加示例消息,可能影响其行为。

通过 Modelfile API,开发者可以轻松地创建针对特定任务或具有特定行为风格的定制模型,而无需深入了解底层的模型格式或工具链。

第五部分:使用场景与集成示例

Ollama API 的灵活性使其适用于各种本地 AI 应用场景:

  • 本地智能助手/聊天机器人: 构建一个桌面应用或命令行工具,通过 API 与 Ollama 进行对话,提供本地的问答或内容生成服务。
  • 离线文档处理与 RAG: 结合本地向量数据库(如 Chroma, Weaviate, Qdrant 等),使用 Ollama API 的 /api/embeddings 生成文档 embedding,构建索引。用户查询时,将查询embedding与文档索引匹配,检索相关片段,然后将片段作为上下文与用户问题一起发送给 Ollama API 的 /api/generate,实现基于本地知识库的问答。
  • 代码助手: 构建一个编辑器插件或独立的工具,利用 Code Llama 等模型通过 API 提供代码补全、解释、重构或生成功能。
  • 内容创作工具: 开发一个写作助手、摘要工具或翻译工具,在本地利用 LLM 的能力。
  • 数据隐私要求高的应用: 在医疗、金融等领域,敏感数据不宜上传云端,Ollama API 提供了在本地处理这些数据的可能性。
  • 教育与研究: 为学生和研究人员提供一个沙箱环境,在本地实验和理解 LLM,而无需担心成本。

简单的 Python 集成示例 (使用 requests 库):

“`python
import requests
import json

Ollama API 地址

OLLAMA_API_URL = “http://localhost:11434”

def generate_text(model_name, prompt, stream=False, options=None):
“””调用 Ollama API 生成文本”””
url = f”{OLLAMA_API_URL}/api/generate”
payload = {
“model”: model_name,
“prompt”: prompt,
“stream”: stream,
}
if options:
payload[“options”] = options

if stream:
    # 处理流式响应
    with requests.post(url, json=payload, stream=True) as r:
        r.raise_for_status()
        for line in r.iter_lines():
            if line:
                try:
                    data = json.loads(line)
                    yield data
                    if data.get("done"):
                        break
                except json.JSONDecodeError:
                    print(f"Error decoding JSON: {line}")
                    continue
else:
    # 处理非流式响应
    response = requests.post(url, json=payload)
    response.raise_for_status()
    return response.json()

def get_embeddings(model_name, text):
“””调用 Ollama API 生成 embedding”””
url = f”{OLLAMA_API_URL}/api/embeddings”
payload = {
“model”: model_name,
“prompt”: text
}
response = requests.post(url, json=payload)
response.raise_for_status()
return response.json()[“embedding”]

— 示例用法 —

if name == “main“:
model = “llama2” # 确保你已经下载了这个模型

print(f"--- 非流式生成示例 ({model}) ---")
try:
    result = generate_text(model, "讲一个关于猫的笑话。")
    print("生成的文本:", result["response"])
    print("上下文:", result["context"]) # 保存上下文用于下一轮对话

    # 假设我们要进行下一轮对话,使用上文返回的context
    # next_prompt = "继续讲。"
    # next_result = generate_text(model, next_prompt, context=result["context"])
    # print("继续生成的文本:", next_result["response"])

except requests.exceptions.RequestException as e:
    print(f"调用生成 API 失败: {e}")
    print("请确保 Ollama 服务正在运行并已下载模型!")


print(f"\n--- 流式生成示例 ({model}) ---")
try:
    print("流式生成中:")
    full_response = ""
    last_context = None
    for chunk in generate_text(model, "请详细描述一下人工智能。", stream=True):
        if chunk.get("response"):
            print(chunk["response"], end="", flush=True)
            full_response += chunk["response"]
        if chunk.get("done"):
            last_context = chunk.get("context")
    print("\n流式生成完成.")
    print("最终上下文:", last_context)

except requests.exceptions.RequestException as e:
    print(f"调用流式生成 API 失败: {e}")
    print("请确保 Ollama 服务正在运行并已下载模型!")

print(f"\n--- Embedding 生成示例 (nomic-embed-text) ---")
embed_model = "nomic-embed-text" # 确保你已经下载了这个 embedding 模型
try:
    text1 = "猫是很可爱的动物。"
    text2 = "狗狗是人类的好朋友。"
    text3 = "猫和狗是常见的宠物。"

    emb1 = get_embeddings(embed_model, text1)
    emb2 = get_embeddings(embed_model, text2)
    emb3 = get_embeddings(embed_model, text3)

    print(f"'{text1}' 的 embedding 向量长度: {len(emb1)}")
    # 在实际应用中,你会计算向量相似度等
    # from numpy import dot
    # from numpy.linalg import norm
    # similarity12 = dot(emb1, emb2)/(norm(emb1)*norm(emb2))
    # similarity13 = dot(emb1, emb3)/(norm(emb1)*norm(emb3))
    # print(f"'{text1}' 和 '{text2}' 的相似度: {similarity12}") # 应该较低
    # print(f"'{text1}' 和 '{text3}' 的相似度: {similarity13}") # 应该较高

except requests.exceptions.RequestException as e:
    print(f"调用 embedding API 失败: {e}")
    print("请确保 Ollama 服务正在运行并已下载 embedding 模型!")

``
这个 Python 示例展示了如何使用
requests` 库与 Ollama API 交互,包括非流式和流式生成文本,以及生成 embedding。你可以根据自己的需求进一步扩展这些代码,构建更复杂的应用。

第六部分:优势与未来展望

Ollama API 的主要优势总结:

  • 本地优先: 数据不离开你的机器。
  • 开放与灵活: 支持多种模型,易于通过 Modelfile 定制。
  • 标准接口: 基于 HTTP REST,兼容性强。
  • 持续发展: 项目活跃,社区支持良好,新功能和模型不断加入。
  • 成本可控: 一次性硬件投入,无持续按量付费压力。

当然,Ollama API 也有其局限性:

  • 硬件依赖: 高性能的模型需要强大的 CPU 或 GPU。
  • 性能受限: 本地硬件性能可能不如大型数据中心的专业加速器。
  • 功能演进: 作为一个相对年轻的项目,API 功能和稳定性仍在快速发展中,可能会有一些变化。

展望未来,Ollama API 有望成为本地 AI 应用开发的基石之一。随着硬件的进步和模型的小型化/优化,在个人设备上运行越来越强大的模型将成为可能。Ollama 及其 API 的易用性将极大地降低开发者利用这些本地化 AI 能力的门槛,催生更多创新性的、注重隐私的、高效的本地应用。与其他开源项目(如向量数据库、本地UI框架等)的结合,将进一步拓展其应用边界。

结论

Ollama API 为开发者提供了一个强大而灵活的方式,将本地运行的大语言模型集成到各种应用程序中。通过标准的 HTTP REST 接口,开发者可以轻松地进行文本生成、embedding 生成以及模型的管理和定制。无论是为了数据隐私、降低成本、实现离线能力,还是仅仅为了实验和学习,Ollama API 都是一个极具价值的工具。

深入理解其核心端点、参数和概念,如流式传输和上下文管理,将使你能够充分发挥本地 LLM 的潜力。随着 Ollama 项目的不断成熟,其 API 也将变得更加完善和强大,为本地 AI 生态的发展注入新的活力。现在,是时候开始探索并利用 Ollama API,开启你的本地 AI 应用开发之旅了!


发表评论

您的邮箱地址不会被公开。 必填项已用 * 标注

滚动至顶部