如何安裝及使用 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 */