如何安装及使用 Hugging Face Unity API

发布于 2023 年 5 月 1 日

Hugging Face Unity API 是一个易于使用的 Hugging Face 推理 API 集成，它允许开发者在他们的 Unity 项目中访问和使用 Hugging Face 的 AI 模型。在这篇博文中，我们将详细介绍安装和使用 Hugging Face Unity API 的步骤。

安装

打开你的 Unity 项目
前往 Window -> Package Manager
点击 + 并选择 Add Package from git URL
输入 https://github.com/huggingface/unity-api.git
安装完成后，Unity API 向导应该会弹出。如果没有，请前往 Window -> Hugging Face API Wizard

输入你的 API 密钥。你可以在 Hugging Face 账户设置中创建 API 密钥。
在 API 向导中点击 Test API key 来测试 API 密钥。
（可选）更改模型端点以切换要使用的模型。任何支持推理 API 的模型的端点都可以在 Hugging Face 网站上找到，方法是转到模型页面，点击 Deploy -> Inference API，然后从 API_URL 字段中复制 URL。
如果需要，配置高级设置。要获取最新信息，请访问项目仓库 https://github.com/huggingface/unity-api
要查看如何使用 API 的示例，请点击 Install Examples。现在你可以关闭 API 向导了。

现在 API 已经设置好，你可以从你的脚本中调用 API。让我们看一个执行句子相似度任务的例子。

using HuggingFace.API;

/* other code */

// Make a call to the API
void Query() {
    string inputText = "I'm on my way to the forest.";
    string[] candidates = {
        "The player is going to the city",
        "The player is going to the wilderness",
        "The player is wandering aimlessly"
    };
    HuggingFaceAPI.SentenceSimilarity(inputText, OnSuccess, OnError, candidates);
}

// If successful, handle the result
void OnSuccess(float[] result) {
    foreach(float value in result) {
        Debug.Log(value);
    }
}

// Otherwise, handle the error
void OnError(string error) {
    Debug.LogError(error);
}

/* other code */