Chat GPTを作るのに必要なもの

ai-plugin.json
openapi.yaml
Webサーバー

たったこれだけでプラグインが作れる。

kurehajime 2023/04/08

ai-plugin.json

ai-plugin.jsonという名前でプラグインを説明するJsonを作る。

{
    "schema_version": "v1",
    "name_for_human": "Anony",
    "name_for_model": "Anony",
    "description_for_human": "文中に含まれる人名をイニシャル化して匿名にするときに使います。",
    "description_for_model": "文中に含まれる人名をイニシャル化して匿名にするときに使います。",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "http://localhost:3333/openapi.yaml",
        "is_user_authenticated": false
    },
    "logo_url": "https://avatars.githubusercontent.com/u/4569916?v=4",
    "contact_email": "xiidec@gmail.com",
    "legal_info_url": "http://www.example.com/legal"
}

重要なのはこの2箇所

"description_for_model": "文中に含まれる人名をイニシャル化して匿名にするときに使います。",

プラグインの説明と使い方を自然言語で書く。
普段のドキュメントはついつい適当に書いてしまいがちだが、ここで書く文章は非常に重要。
Chat GPTはこの文章を読んでプラグインをどのような場面で使うかを判断する。

"url": "http://localhost:3333/openapi.yaml",

そしてここも重要。
OpenAPIのスキーマファイルを配置している場所を書く。
「OpenAPI」と「OpenAI」は似ているので混同しがちだが、関係ない。

Open APIとはこんな感じのもの。

kurehajime 2023/04/08

openapi.yaml

Open APIとは、ようするにこんな感じのツール。

こんな感じのyamlファイルを作って置くと、そこから型定義などを勝手に作ってくれたりする。
Chat GPTはこの定義ファイルを読み取ってAPIの叩き方を知る。

openapi: 3.0.1
info:
  title: Anony Plugin
  description: 文中に含まれる人名をイニシャル化して匿名にするプラグインです。
  version: 'v1'
servers:
  - url: http://localhost:3333
paths:
  /query:
    post:
      operationId: query
      summary: 文中に含まれる人名をイニシャル化して匿名にするときに使います。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Req'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Res'
components:
  schemas:
    Req:
      type: object
      properties:
        query:
          type: string
          description: Text to be initialed with a person's name
      required:
      - query
    Res:
      type: object
      properties:
        answer:
          type: string
          description: Sentences initialed with the person's name
      required:
        - answer

kurehajime 2023/04/08

Webサーバー

Webサーバーには以下の機能が求められる。

/.well-known/ai-plugin.json
- ファイルの置き場所はこの場所でなくてはならない。
openapi.yaml
- これがどこにあるかはai-plugin.jsonで指定する。openapi.yamlでもopenapi.jsonでもいい。
Chat GPTに利用してもらいたいAPI
- 利用してもらいたいAPIを用意する。ai-plugin.jsonを配信するドメインと同じである必要がある。Chat GPTはai-plugin.jsonとopenapi.yamlの情報だけを手がかりにしてAPIを叩いてくれる。適切な形で利用してくれるかどうかは説明文とプロンプトと運にかかっている。