Third-Party APIを使用してOpenAI Custom GPTを構築する方法

チュートリアル

大规模言語モデル（LLM）の到来により、会話型のユーザーインターフェースが非常に人気を博しています。何か探していることがあれば、ChatGPTが出力を生成するだけです。また、このモデルはあなたの命令や質問に対してアクションを実行し、結果をあなたに表示することもできます。これは、ユーザーの言葉だけを入力として、新しい種類のインターフェースを構築する大きな機会を開辟しました。

これは素晴らしいことで、考える限り可能な多くの可能性を開けています。私たちが必要とするのは、LLMが可能な限り多くの複雑な、実際の世界の行動にアクセスし、適切に呼び出すことです。ここに、第三者のAPIが役立ちます。

プラットフォーム API

人気のあるインターネットサービスについて考えてください。それぞれのサービスは、そのサービスで通常行われる業務を行うために呼び出すことができるAPIを提供します。各サービスは通常、よいグラフィカルユーザーインターフェース（GUI）を提供します。それはwebアプリまたはモバイルアプリとしてあり、ユーザーはそれにログインして使用します。しかし、代わりに、ユーザーがテキストまたは音声コマンドを介して单一の实体に Askするのです。他のインターフェースは不要です。

興味深いことに、現在、特定のアクションを極めて良く認識し、それを認識してスペシャリストになるGPTのカスタムバージョンを構築することができます。これは、ユーザーの意図と望まれるアクションを結びつけ、実行されたアクションの結果（出力）を共有します。

OpenAPI YAML仕様

カスタムGPTの場合、これはOpenAPI仕様を使用してサードパーティAPIを登録することで実現されます。例えば、こちらはAIインテリアデザインプラットフォームのOpenAPI仕様です。このAPIを使えば、部屋の写真だけで新しいインテリアデザインを作成することができます。プラットフォームは独自のウェブアプリを提供しており、ユーザーが部屋の写真をアップロードし、インテリアデザインスタイルを選択して新しいデザインを生成できますが、これをカスタムGPTとしてデプロイすることで自分のプラットフォームにこの機能を持ち込むことができます。

このAPIを例にしてカスタムGPTを構築しましょう。OpenAPI Specを使ってどのサードパーティAPIでもオンボードできます。また、自分のプラットフォームAPIのOpenAPI Specを作成するのに役立つツールもあります。自分のAPIをより広いプラットフォームに配布する素晴らしい方法だと思います。

プラットフォームAPIの取得

ほとんどのSaaSプラットフォームは、開発者がアプリを構築できるようにAPIを提供しています。また、OpenAPI仕様を公開しています。仕様をダウンロードします。それは次のようなYAMLファイルです。

YAML

openapi: 3.1.0
info:
  title: Decor8AI Virtual Staging & Interior Design API
  version: "1.0"
  description: >
    Decor8 AI is a state-of-the-art virtual staging solution designed for realtors and real estate app developers. It provides a suite of customization options to create and visualize appealing interiors from empty spaces. With its focus on enhancing marketability, it's an essential tool for showcasing property potential in a compelling way.
    Please reach out to [Decor8 AI Team](mailto:[email protected]) with questions or suggestions.

    Additional license information can be found [here](https://github.com/immex-tech/decor8ai-sdk/blob/main/API_LICENSE_NOTICE).

    ### はじめに

    - **Authentication**: Each API request requires two headers:
      - `Content-Type: application/json`
      - `Authorization: Bearer `

    - **API Key**: Get your `` from your account at [prod-app.decor8.ai](https://prod-app.decor8.ai).
  
    ### [Decor8 AI](https://prod-app.decor8.ai)にサインインし、左のサイドメニューからAPIをクリック

    ![](https://github.com/immex-tech/decor8ai-sdk/blob/main/media/step_1.jpg?raw=true)

    ### APIキーを生成をクリック
    ![](https://github.com/immex-tech/decor8ai-sdk/blob/main/media/step_2.jpg?raw=true)

    ### AIキーをテスト 
    Once you have the key, run simple curl command to test the key.

    ```
    curl -X GET "https://api.decor8.ai/speak_friend_and_enter" -H "Authorization: Bearer "
    ``` 

  license:
    name: Decor8AI SDK License
    url: https://github.com/immex-tech/decor8ai-sdk/blob/main/LICENSE
servers:
  - url: https://api.decor8.ai
    description: Base API URL for all endpoints.

注: これは完全なOpenAPI Specではなく、ファイルの一部の行だけです。

Open AIカスタムGPT

Custom GPTを作成するには、Open AIのサブスクリプションが必要です。https://chat.openai.com/に移動し、页面の右上隅にあるあなたのプロフィール画像をクリックしてください。

“My GPTs”メニューをクリックします。ここで、新しいCustom GPTを作成します（私は既に1つのCustom GPTを作成しているため、このページに既に表示されています）。

“Create a GPT”をクリックします。これで、このカスタムGPTの属性を定義するフォームが表示されます。

“Configure”タブをクリックします。

ここで、ロゴ、名前、説明と初期の指示を提供します。

指示で、地ごとのルールを定義することが重要です。たとえば、GPTが自身の専門分野を越えた質問に答える際に、GPTが何をするべきかを定義したいです。GPTは「私は知らない」と言うか、それができることを用户に知らせるべきです。これは、正しいユーザーの期待を設定するとても役立ちます。

“Actions”セクションを下にスクロールします。

アクションは、特定の条件を満たした時にGPTが「何を呼び出すべきか」を知る手段です。各API呼び出しがアクションになることができます。これは、先ほど下载したOpenAPISpec YAMLファイルを必要とします。

認証: APIキーを選択してください

認証タイプ: Bearerを選択してください

APIキーを取得してください

通常、すべてのプラットフォームAPIは、APIキーを使用した認証方法を提供します。そのプラットフォームにサインインしてキーを取得します。たとえば、Decor8 AIの場合、https://prod-app.decor8.ai にログインし、APIメニューをクリックします。ここでAPIキーを作成できます。そのキーをコピーして、Authenticationポップアップに貼り付けます。

次に、OpenAPI仕様のYAMLファイルの内容を「Schema」テキストボックスにコピーして貼り付けます。

仕様が適切にフォーマットされていれば、仕様に記載されているAPIコールの一覧が表示されます。これらを個別にテストできます。「Test」ボタンをクリックすると、仕様で説明されている正しい入力パラメータでAPIを呼び出そうとします。入力パラメータの値を取得する必要がある場合は、聞いてきます。

Decor8 AI APIの場合、「checkAuthentication」APIをテストしてみましょう（これはGPT自体には必要ありません）。これが正常に呼び出されると、Custom GPTとターゲットプラットフォーム（この場合はDecor8 AI）の間が正しく設定されていることを意味します。

残りのAPIも一つ一つテストして、GPTがアクションを正しく理解しているか確認できます。確認するのは、アクションを実行する際に提供されていない追加の入力をGPTが求めてくるかどうかです。これがCustom GPTの最も興味深い部分です：仕様に従ってAPIを呼び出し、入力パラメータを構築する方法を「知っている」ので、入力が不足している場合はユーザーに尋ねます。これが会話型ユーザーインターフェースの見た目です。