聊天插件系統(tǒng)是一種令人興奮的新方式，可以擴展ChatGPT的功能，納入您自己的業(yè)務數(shù)據(jù)，并為客戶與您的業(yè)務互動增加另一個渠道。在這篇文章中，我將解釋什么是聊天插件，它們能做什么，以及你如何用JavaScript建立你自己的聊天插件。

這篇文章（或OpenAI所稱的"訓練數(shù)據(jù)"）提供了一個快速入門指南，來建立你的第一個ChatGPT插件，并將其與ChatGPT界面整合。

聊天插件是否會成為改變生活的賈維斯般的體驗，或者只是一個昂貴的Alexa-for-your-browser，目前還沒有定論。讓我們通過看看插件能提供什么，需要注意什么，以及如何制作你自己的插件，來決定我們自己的想法。

目錄

• 什么是聊天插件?

插件組成部分

聊天插件生態(tài)系統(tǒng)的新機遇

插件開發(fā)的考量和局限

• 設置項目
• 添加OpenAI清單和API規(guī)范
• 創(chuàng)建服務器
• 設置強制性的插件路由
• 設置Todo路由
• 驗證和測試插件
• (可選）將該服務器作為代理
• 下一步
  

什么是聊天插件？

"聊天插件"允許ChatGPT模型使用并與第三方應用程序互動。從本質(zhì)上講，它是一套指令和規(guī)范，語言模型可以遵循這些指令和規(guī)范在聊天對話中創(chuàng)建API的調(diào)用和操作。與第三方系統(tǒng)的整合為ChatGPT的用戶提供了一系列新的功能：

• 創(chuàng)建、更新和修改我們自己的業(yè)務數(shù)據(jù)和數(shù)據(jù)庫（如銷售、營銷系統(tǒng)）
• 從外部服務中獲取信息（如金融、天氣API）
• 執(zhí)行操作（例如，發(fā)送Slack消息）

插件組成部分

建立一個能與AI互動的應用程序似乎是一個令人生畏的復雜系統(tǒng)，然而，一旦你開始做，你會發(fā)現(xiàn)它非常簡單。一個"插件"是一套簡單的指令，它告訴ChatGPT模型你的API是做什么的，以及如何和何時訪問它。

這可以歸結為兩個重要文件：

1. ai-plugin.json：插件清單，包含插件的基本元數(shù)據(jù)。這包括名稱、作者、描述、認證和聯(lián)系等細節(jié)。該清單被ChatGPT用來理解插件的作用。
2. openapi.yaml：在OpenAPI規(guī)范中，你的API路由和模式的規(guī)范。也可以以json文件的形式提供。這將告訴ChatGPT可以使用哪些API，出于什么原因，以及請求和響應會是什么樣子。

插件服務的基礎功能和托管由你決定。你的API可以托管在任何地方，使用任何REST API或編程語言。

聊天插件生態(tài)系統(tǒng)的新機遇

聊天插件的到來為開發(fā)者、設計師、企業(yè)和企業(yè)家?guī)砹艘幌盗械臋C會：

• 「交互可以更"聰明"和更"流暢"」 ：插件引入了人性化、假設和上下文的能力，并結合請求提供這些能力。這為互動增加了一個流動性的元素，而這是一個死板的GUI或結構化的數(shù)據(jù)API所不能滿足的。例如，"我今天應該穿外套嗎？"這個提示將導致API調(diào)用一個基于你的位置的天氣服務，對天氣的解釋，以及對原始問題的回答："是的，你應該穿一件夾克。今天的溫度是12度，有80%的機會下雨。"。
• 「新的客戶渠道」：ChatGPT在2023年4月以1.73億活躍用戶創(chuàng)造了增長最快的用戶記錄。毫無疑問，在這個平臺上占有一席之地，為你提供了接觸大量潛在客戶的機會。它還提供了一種潛在的更容易、更直觀、更容易與使用它的現(xiàn)有客戶互動的方式。
• 「人工智能界面（A.I.I.）的崛起」：用戶現(xiàn)在無需點擊"按鈕"就可以執(zhí)行復雜的操作。從理論上講，一個插件可以提供一個驚人的服務，而不需要像傳統(tǒng)的用戶界面那樣需要關注界面才行（或根本不需要）。一個直觀的規(guī)范可能變得和一個直觀的網(wǎng)絡應用一樣重要。
• 「新的商業(yè)機會」：人工智能在提供工作的同時也會帶走工作。如果成功的話，插件生態(tài)系統(tǒng)將為插件開發(fā)者、人工智能API開發(fā)者，以及為企業(yè)托管、認證和管理插件的全新垂直業(yè)務創(chuàng)造新的機會和空間。

插件開發(fā)的考量和局限

直觀和無代碼界面的好處帶來了一系列挑戰(zhàn)。承認生態(tài)系統(tǒng)、邏輯和界面會隨著時間的推移而發(fā)展，在構建插件時，我們?nèi)匀恍枰涀∫恍┦虑椤Ｌ貏e是如果你想把它們作為一項業(yè)務來建立。

• 「響應速度慢」：解釋自然語言、選擇插件、建立請求和解釋響應都需要時間。對于簡單的信息請求或操作，自己做就可以更快。根據(jù)上面的例子，我看一下我的手機主屏幕比等待15秒讓ChatGPT解釋天氣并寫給我要快得多。
• 「成本高」：用戶將花費token來與任何插件互動。這增加了潛在的成本，即使你是免費提供給他們的東西。你還必須為托管和運營這些API的基礎設施付費。
• 「不同方式」：在內(nèi)部，與插件的互動仍然是REST API，只能執(zhí)行我們與其他客戶端相同的操作。插件更像是一個與企業(yè)互動的新渠道，而不是目前讓人工智能為我們服務的新范式。
• 「可操縱性」：由于用戶在默認情況下看不到API響應，誤導性信息和其他惡意策略可能會被插件制造商用來歪曲答案。
• 「不可預測性」：讓生成模型負責決策是有風險的，行為是不可靠的。有很多推理和猜測工作在幕后發(fā)生，以根據(jù)人類書面聊天提示創(chuàng)建API請求。打字不規(guī)范的信息或含糊不清的描述可能會導致調(diào)用錯誤的API或做出錯誤的行動。

構建第一個JavaScript ChatGPT 插件

我們將為我們的聊天插件建立自己的express服務器。這不僅是一個容易上手的方法，而且express可以被擴展到包括中間件、認證和所有其他你想要的生產(chǎn)級的東西。

以下是我們將在下列步驟中創(chuàng)建和添加代碼的所有文件。如果你感到困惑，可以回到這里，或者克隆這里的源碼[1]。

my-chat-plugin/
├─ .well-known/
│  ├─ ai-plugin.json  <- 插件元數(shù)據(jù)
├─ routes/
│  ├─ todos.js        <- 處理Todo請求的路由
│  ├─ openai.js       <- 處理openAI請求的路由
openapi.yaml          <- Open API規(guī)范
index.js              <- 插件入口

「先決條件」

1. 「OpenAI賬號」：在這里注冊[2]
2. 「ChatGPT插件訪問」：如果你還沒有通過付費賬戶訪問，你可以在這里[3]加入等待名單。

設置項目

創(chuàng)建一個名為my-chat-plugin的文件夾，執(zhí)行下面的命令來開始：

## 1. Create the directory and open it
mkdir my-chat-plugin && cd my-chat-plugin

## 2. Initialize a project with the default values
npm init --yes

## 3. Install our dependencies
npm install axios express cors js-yaml

添加OpenAI清單和API規(guī)范

現(xiàn)在，我們要創(chuàng)建所需的聊天插件清單和OpenAPI規(guī)范。ChatGPT會在你服務器的特定路由上請求這些文件，所以我們要把它們放在：

• /.well-known/ai-plugin.json
• /openapi.yaml

這些文件中的描述是非常重要的！如果你在summary和description_for_model字段中的語言含糊不清，你可能會讓ChatGPT對何時和如何使用你的插件感到困惑。請遵循以下步驟：

1. 創(chuàng)建一個名為.well-known的文件夾，并在其中添加一個名為ai-plugin.json的文件。通過終端進行操作：

mkdir .well-known && touch .well-known/ai-plugin.json

粘貼下面代碼到ai-plugin.json中：

{
    "schema_version": "v1",
    "name_for_human": "My ChatGPT To Do Plugin",
    "name_for_model": "todo",
    "description_for_human": "Plugin for managing a To Do list. You can add, remove and view your To Dos.",
    "description_for_model": "Plugin for managing a To Do list. You can add, remove and view your ToDos.",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "<http://localhost:3000/openapi.yaml>",
        "is_user_authenticated": false
    },
    "logo_url": "<http://localhost:3000/logo.png>",
    "contact_email": "support@yourdomain.com",
    "legal_info_url": "<http://www.yourdomain.com/legal>"
}

1. 在項目根路徑下創(chuàng)建一個名為openapi.yaml，并且添加下列代碼到文件中。

這是OpenAPI規(guī)范，ChatGPT會用它來理解您的API路由的作用（注意每個路由的summary）以及請求和響應的格式。如果ChatGPT在使用您的API時遇到問題，十有八九是因為這個規(guī)范與您的API的響應不一致。

openapi: 3.0.1
info:
  title: TODO Plugin
  description: A plugin that allows the user to create and manage a To Do list using ChatGPT.
  version: 'v1'
servers:
  - url: <http://localhost:3000>
paths:
  /todos:
    get:
      operationId: getTodos
      summary: Get the list of todos
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Todo'
    post:
      operationId: addTodo
      summary: Add a todo to the list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Todo'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Todo'
  /todos/{id}:
    delete:
      operationId: removeTodo
      summary: Delete a todo from the list when it is complete, or no longer required.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        "204":
          description: No Content
components:
  schemas:
    Todo:
      type: object
      properties:
        id:
          type: integer
          format: int64
        task:
          type: string
      required:
        - id
        - task

創(chuàng)建服務器

我們的下一步是創(chuàng)建我們的主文件，也就是我們插件的入口。在項目根目錄下，添加一個名為index.js的文件，并添加以下代碼。

注意：ChatGPT文檔顯示openapi.yaml和openapi.json都有一個路由。本地測試顯示只有yaml文件被請求，但值得把它們都放在那里，因為以后可能會用到。

粘貼下面代碼到index.js中：

const express = require('express');
const cors = require('cors');
const todoRouter = require('./routes/todos');
const openaiRoutes = require('./routes/openai');

const app = express();
const PORT = 3000;

// Setting CORS to allow chat.openapi.com is required for ChatGPT to access your plugin
app.use(cors({ origin: [`http://localhost:${PORT}`, '<https://chat.openai.com>'] }));
app.use(express.json());

// Simple request logging to see if your plugin is being called by ChatGPT
app.use((req, res, next) => {
  console.log(`Request received: ${req.method}: ${req.path}`)
  next()
})

// OpenAI Required Routes
app.use(openaiRoutes);

// The dummy todos API
app.use('/todos', todoRouter);

app.listen(PORT, () => {
  console.log(`Plugin server listening on port ${PORT}`);
});

上述代碼做了下列事情：

• 導入express和cors所需的庫
• 導入我們的路由特定邏輯，在下一步添加
• 添加日志中間件，將任何傳入的請求打印到控制臺中
• 提供一個通用的轉發(fā)函數(shù)，如果你已經(jīng)有一個API服務就可以使用

設置強制性的插件路由

在這一步中，我們將為OpenAI / ChatGPT添加強制性的路由，來獲取所需文件。我們將把所有具體的路由邏輯放在一個"routes"目錄中。這就是我們將存儲插件路由以及其他自定義路由的地方。

(你可能希望用額外的文件夾（控制器、中間件、服務等）擴展這個結構，或者創(chuàng)建你自己的結構）。

1. 創(chuàng)建/routes文件夾
2. 創(chuàng)建名為openai.js的文件
3. 粘貼下列代碼到routes/openai.js中：

const express = require('express');
const router = express.Router();
const fs = require('fs');
const path = require('path');
const yaml = require('js-yaml');

router.get('/openapi.yaml', async function(req, res) {
  try {
    const yamlData = fs.readFileSync(path.join(process.cwd(), 'openapi.yaml'), 'utf8');
    const jsonData = yaml.load(yamlData);
    res.json(jsonData);

  } catch(e) {
    console.log(e.message)
    res.status(500).send({ error: 'Unable to fetch manifest.' });
  }
});

router.get('/.well-known/ai-plugin.json', function(req, res) {
  res.sendFile(path.join(process.cwd(), '/.well-known/ai-plugin.json'));
});

router.get('/logo.png', function(req, res) {
  res.sendFile(path.join(process.cwd(), 'logo.png'));
})

module.exports = router;

上述代碼做了下列事情：

• 定義了兩個路由，供插件檢索你的清單和API規(guī)范。
• 定義了一個路由，讓插件在聊天中檢索并顯示你的插件標識。
• 導出所有的路由，以便我們可以在index.js中導入它們。

設置Todo路由

現(xiàn)在我們將創(chuàng)建一些簡單的路由來模擬一個簡單的創(chuàng)建、更新、刪除功能。我們通常避免使用todo教程，但考慮到文檔中使用這個作為指南，我們希望盡可能保持它的可轉移性。

1. 在你的路由文件夾中，創(chuàng)建一個名為todos.js的新文件
2. 將以下代碼粘貼到routes/todos.js中：

const express = require('express');
const router = express.Router();

let todos = [
    { id: 1, task: 'Wake up' },
    { id: 2, task: 'Grab a brush'},
    { id: 3, task: 'Put a little makeup'},
    { id: 4, task: 'Build a Chat Plugin'}
]; // placeholder todos

let currentId = 5; // to assign unique ids to new todos

getTodos = async function(req, res) {
    res.json(todos);
}

addTodo = async function(req, res) {
    const { task } = req.body;
    const newTodo = { id: currentId, task };
    todos.push(newTodo);
    currentId++;
    res.json(newTodo);
}

removeTodo = async function(req, res) {
    const { id } = req.params;
    todos = todos.filter(todo => todo.id !== Number(id));
    res.json({ "message" : "Todo successfully deleted" });
}

router.get('/', getTodos);
router.post('/', addTodo);
router.delete('/:id', removeTodo);

module.exports = router;

上述代碼做了下列事情：

• 創(chuàng)建3條路由，從一個簡單的todo項目列表中獲取、創(chuàng)建和刪除。
• 將這些路由導出，導入到我們的index.js文件。

驗證和測試插件

現(xiàn)在，有趣的部分來了。我們已經(jīng)有了所有必要的代碼和設置，可以在ChatGPT上手動建立和運行一個本地插件了！我們開始吧：

1. 「開啟服務」

在終端中輸入node index.js。這會在終端中開啟服務并打印’Plugin server listening on port 3000’。

2. 「將其連接到ChatGPT本地插件」

進入chat.openai.com[4]，在你的賬戶中打開一個新的聊天窗口。點擊GPT-4下拉菜單，Plugins > Plugin Store > 點擊Develop Your Own Plugin > 輸入localhost:3000 > 點擊「Find manifest file」。

3. 「測試插件」

你應該看到一條驗證信息，即ChatGPT能夠獲得你的清單文件，這樣你就可以開始了。如果沒有，請檢查你的終端，服務器正在運行，并且正在接收傳入的請求。

試試下面的一些命令：

• "what are my todos?"
• I have woken up（你不需要說出確切的Todo任務，它就能理解你指的是什么）

(可選）將該服務器作為代理

如果你已經(jīng)有一個在本地或外部運行的API來發(fā)送請求，你可以把這個服務器作為一個代理，把請求轉發(fā)給它。這是一個值得推薦的選項，因為它使你能夠快速測試和迭代如何處理清單和規(guī)范文件，而不必重新部署或更新你現(xiàn)有的代碼庫。

在你創(chuàng)建的路由下的index.js中添加以下代碼：

// PASTE IN BEFORE app.listen(... 

// Proxy server to an existing API
const api_url = '<http://localhost>';

app.all('/:path', async (req, res) => {
  const { path } = req.params;
  const url = `${api_url}/${path}`;

  console.log(`Forwarding call: ${req.method} ${path} -> ${url}`);

  const headers = {
    'Content-Type': 'application/json',
  };

  try {
    const response = await axios({
      method: req.method,
      url,
      headers,
      params: req.query,
      data: req.body,
    });

    res.send(response.data);
  } catch (error) {
    console.error(`Error in forwarding call: ${error}`);
    res.status(500).send('Error in forwarding call');
  }
});

下一步

這個基本教程應該是你開始建立自己的基于JavaScript的成熟聊天插件所需要的。將你的應用程序部署到生產(chǎn)環(huán)境中，需要一些額外的認證和部署步驟。教程中沒有提到這些，但我推薦以下資源來完成這些工作：

• 官方插件實例[5]：服務水平認證，和檢索插件。
• 生產(chǎn)你的應用程序[6]：在Plugin store中出現(xiàn)的主機、安全和性能要求有關的官方指南。

本文譯自：https://www.sitepoint.com/javascript-chatgpt-plugin/[7]

以上就是本文的全部內(nèi)容，感謝閱讀。

參考資料

[1]源碼:https://github.com/sitepoint-editors/chatgpt-plugin-quickstart-js

[2]注冊:https://platform.openai.com/signup?launch

[3]這里:https://openai.com/waitlist/plugins

[4]chat.openai.com:https://chat.openai.com/

[5]官方插件實例:https://platform.openai.com/docs/plugins/examples

[6]生產(chǎn)你的應用程序:https://platform.openai.com/docs/plugins/production/domain-verification-and-security

[7]https://www.sitepoint.com/javascript-chatgpt-plugin/:https://www.sitepoint.com/javascript-chatgpt-plugin/