Huggingface.js 文档

🤗 Hugging Face Agents.js

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始

🤗 Hugging Face Agents.js

一种使用 LLM 从自然语言调用 Hugging Face 模型和推理端点的方法。

安装

pnpm add @huggingface/agents

npm add @huggingface/agents

yarn add @huggingface/agents

Deno

// esm.sh
import { HfAgent } from "https://esm.sh/@huggingface/agent"
// or npm:
import { HfAgent } from "npm:@huggingface/agent"

用法

Agents.js 利用 HF 上托管为推理端点的 LLM,因此您需要创建一个帐户并生成一个 访问令牌

import { HfAgent } from "@huggingface/agents";

const agent = new HfAgent("hf_...");

const code = await agent.generateCode("Draw a picture of a cat, wearing a top hat.")
console.log(code) // always good to check the generated code before running it
const outputs = await agent.evaluateCode(code);
console.log(outputs) 

选择您的 LLM

您也可以使用自己的 LLM,通过调用其中一个 LLMFrom* 函数。

从 Hub 中

只要它们有 API,您就可以指定 Hub 上的任何有效模型。

import { HfAgent, LLMFromHub } from "@huggingface/agents";

const agent = new HfAgent(
  "hf_...",
  LLMFromHub("hf_...", "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5")
);

从您自己的端点

您也可以指定您自己的端点,只要它实现了相同的 API,例如使用 文本生成推理推理端点

import { HfAgent, LLMFromEndpoint } from "@huggingface/agents";

const agent = new HfAgent(
  "hf_...",
  LLMFromEndpoint("hf_...", "http://...")
);

自定义 LLM

在此上下文中,LLM 被定义为任何接收字符串输入并返回字符串的异步函数。例如,如果您想使用 OpenAI API,您可以这样做

import { HfAgent } from "@huggingface/agents";
import { Configuration, OpenAIApi } from "openai";

const api = new OpenAIApi(new Configuration({ apiKey: "sk-..." }));

const llmOpenAI = async (prompt: string): Promise<string> => {
  return (
    (
      await api.createCompletion({
        model: "text-davinci-003",
        prompt: prompt,
        max_tokens: 1000,
      })
    ).data.choices[0].text ?? ""
  );
};

const agent = new HfAgent(
  "hf_...",
  llmOpenAI
);

// do anything you want with the agent here

工具

默认情况下,代理附带 4 个工具。(textToImage、textToSpeech、imageToText、speechToText)

但是您可以通过创建新工具并在初始化时传递它们来轻松扩展工具列表。

import { HfAgent, defaultTools, LLMFromHub } from "@huggingface/agents";
import type { Tool } from "@huggingface/agents/src/types";

// define the tool
const uppercaseTool: Tool = {
    name: "uppercase",
    description: "uppercase the input string and returns it ",
    examples: [
        {
            prompt: "uppercase the string: hello world",
            code: `const output = uppercase("hello world")`,
            tools: ["uppercase"],
        },
    ],
    call: async (input) => {
        const data = await input;
        if (typeof data !== "string") {
            throw new Error("Input must be a string");
        }
        return data.toUpperCase();
    },
};

// pass it in the agent
const agent = new HfAgent(process.env.HF_TOKEN,
                LLMFromHub("hf_...", "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5"),
                [uppercaseTool, ...defaultTools]);

依赖项

  • @huggingface/inference : 需要调用推理端点本身。
< > 在 GitHub 上更新