LLM Functions

本项目使你能够使用熟悉的 Bash、JavaScript 和 Python 语言，轻松构建强大的 LLM 工具（Tools）和智能体（Agents）。

无需复杂的集成，通过利用 Function Calling 的强大功能，你可以将 LLM 直接连接到自定义代码中，从而开启无限可能。执行系统命令、处理数据、与 API 交互——唯一限制你的只有你的想象力。

工具展示 llm-function-tool

智能体展示 llm-function-agent

前置条件

请确保已安装以下工具：

argc：一个 Bash 命令行框架和命令运行器
jq：一个 JSON 处理器

开始使用 AIChat

目前，AIChat 是唯一支持 llm-functions 的 CLI 工具。我们期待更多工具支持 llm-functions。

1. 克隆仓库

git clone https://github.com/sigoden/llm-functions
cd llm-functions

2. 构建工具和智能体

I. 创建一个 `./tools.txt` 文件，每行包含一个工具文件名。

get_current_weather.sh
execute_command.sh
#execute_py_code.py

web_search 工具在哪里？

web_search 工具本身并不直接存在，你可以从多种网络搜索工具中进行选择。

要将其中的一个用作 web_search 工具，请遵循以下步骤：

选择工具： 可用工具包括：
- web_search_cohere.sh
- web_search_perplexity.sh
- web_search_tavily.sh
- web_search_vertexai.sh
链接你的选择： 使用 argc 命令将你选择的工具链接为 web_search。例如，要使用 web_search_perplexity.sh：
```
$ argc link-web-search web_search_perplexity.sh
```
此命令会创建一个符号链接，使 web_search.sh 指向你选定的 web_search_perplexity.sh 工具。

现在，web_search.sh 已经准备好可以添加到你的 ./tools.txt 中了。

II. 创建一个 `./agents.txt` 文件，每行包含一个智能体名称。

coder
todo

III. 构建 `bin` 和 `functions.json`

argc build

IV. 确保一切准备就绪（环境变量、Node/Python 依赖、mcp-bridge 服务器）

argc check

3. 链接 LLM-functions 和 AIChat

AIChat 需要将 LLM-functions 放置在 AIChat 的 functions_dir 中，以便 AIChat 能够使用 LLM-functions 提供的工具和智能体。

你可以通过以下命令将此仓库目录软链接到 AIChat 的 functions_dir：

ln -s "$(pwd)" "$(aichat --info | sed -n 's/^functions_dir\s\+//p')"
# 或者
argc link-to-aichat

或者，你可以使用环境变量告知 AIChat LLM-functions 目录的位置：

export AICHAT_FUNCTIONS_DIR="$(pwd)"

4. 开始使用函数

完成！现在你可以在 AIChat 中使用这些工具和智能体了。

aichat --role %functions% what is the weather in Paris?
aichat --agent todo list all my todos

编写你自己的工具

为我们的平台构建工具非常简单。你可以利用现有的编程知识，因为工具本质上就是用你偏好的语言编写的函数。

LLM Functions 会根据注释自动生成工具的 JSON 声明。请参考 ./tools/demo_tool.{sh,js,py} 获取如何使用注释进行声明自动生成的示例。

Bash

在 ./tools/ 目录下创建一个新的 Bash 脚本（例如 execute_command.sh）。

#!/usr/bin/env bash
set -e

# @describe Execute the shell command.
# @option --command! The command to execute.

main() {
    eval "$argc_command" >> "$LLM_OUTPUT"
}

eval "$(argc --argc-eval "$0" "$@")"

Javascript

在 ./tools/ 目录下创建一个新的 JavaScript 文件（例如 execute_js_code.js）。

/**
 * Execute the javascript code in node.js.
 * @typedef {Object} Args
 * @property {string} code - Javascript code to execute, such as `console.log("hello world")`
 * @param {Args} args
 */
exports.run = function ({ code }) {
  eval(code);
}

Python

在 ./tools/ 目录下创建一个新的 Python 脚本（例如 execute_py_code.py）。

def run(code: str):
    """Execute the python code.
    Args:
        code: Python code to execute, such as `print("hello world")`
    """
    exec(code)

编写你自己的智能体

智能体（Agent）= Prompt + Tools（函数调用）+ Documents（RAG），这等同于 OpenAI 的 GPTs。

智能体具有以下文件夹结构：

└── agents
    └── myagent
        ├── functions.json                  # 函数的 JSON 声明（自动生成）
        ├── index.yaml                      # 智能体定义
        ├── tools.txt

sigoden/llm-functions