Oracle Cloud Infrastructureドキュメント

生成AIエージェントでのAPIエンドポイント・コール・ツールの作成

生成AIエージェントでは、各エージェントに1つ以上のツールが必要です。エージェントの作成中または作成後に、エージェントのツールを作成できます。どちらのオプションでも、ツールの作成のステップは同じです。この項では、APIエンドポイント・コール・ツールを作成するステップを示します。

開始する前に、生成AIエージェント用のAPIエンドポイント・コール・ツールのガイドラインを確認し、必要なタスクを完了します。たとえば、OCI Vaultシークレットを作成し、ボールト・シークレットにアクセスするためのポリシーを追加する必要がある場合があります。

APIエンドポイント・コール・ツールの作成

  1. 「ツールの作成」、「カスタム・ツール」の順に選択します。
  2. このツールの名前と説明を入力します。
  3. 「ツール構成」で、「APIエンドポイント呼出し(エージェント実行)」を選択します。
  4. (オプション)該当する場合は、例を選択します。

    例を選択すると、「インライン」インポートの「APIスキーマ」ボックスに例がコピーされます。ステップ6に進みます。

  5. 「APIスキーマのインポート」で、次のいずれかのオプションを選択して、このツールのAPIスキーマを指定します。APIスキーマは、APIエンドポイントの操作およびメソッドを記述します。
    • インライン: 小規模なスキーマの場合、APIエンドポイントの操作およびメソッドを含む文字列を入力できます。
    • オブジェクト・ストレージから選択: 頻繁に更新される大規模なスキーマまたはスキーマの場合は、コンパートメントおよびバケットを選択します。次に、APIスキーマを含むファイルを選択します。
  6. 「認証タイプ」で、次のいずれかのオプションを選択し、必要に応じてツール構成を完了します。
    • なし: 認証を必要としないパブリックまたはプライベートAPIエンドポイントをコールする場合。選択すると、コール・リクエストに認証ヘッダーは追加されません。
    • APIキー: APIキーは、クライアントがAPIコールを行うときに提供するトークンです。APIキーは、OCI Vaultシークレットに格納する必要があります。
      • キーの場所: コール・リクエスト内のAPIキーの場所を指定します。
        • 「ヘッダー」を選択して、リクエスト・ヘッダーにキーを送信します。
        • リクエストでキーを問合せパラメータとして渡すには、「問合せパラメータ」を選択します。
      • キー名: ヘッダー・キーの名前(Authorizationなど)または問合せパラメータのキー名(appidなど)を入力します。
      • ボールト・シークレットの選択: 適切なコンパートメントで、APIキーを持つOCI Vaultシークレットを選択します。
    • 基本: ユーザー名とパスワードを使用したHTTP基本認証。資格証明は、<your-username>:<your-password>の形式で指定し、OCI Vaultシークレットに格納する必要があります。
      • ボールト・シークレットの選択: 適切なコンパートメントで、必要な形式の資格証明を持つOCI Vaultシークレットを選択します。
    • ベアラー: ベアラー・トークンを使用したOAuth 2.0認証。トークンはOCI Vaultシークレットに格納する必要があります。
      • ボールト・シークレットの選択: 適切なコンパートメントで、トークンを含むOCI Vaultシークレットを選択します。
    • IDCS: Oracle Identity Cloud Service (IDCS)機密アプリケーションから取得されたクライアントIDおよびクライアント・シークレットを使用したOAuth 2.0認証。クライアント・シークレットは、OCI Vaultシークレットに格納する必要があります。
      • アイデンティティ・ドメイン: 適切なコンパートメントで、このツールを作成するアイデンティティ・ドメインを選択します。
      • クライアントID: 機密アプリケーションのクライアントIDを入力します。
      • クライアント・シークレット: 適切なコンパートメントで、機密アプリケーションのクライアント・シークレットを持つOCI Vaultシークレットを選択します。
      • スコープURL: アクセス可能なリソースおよび操作の特定のセットを定義するスコープURLを入力します。
    • OCIリソース・プリンシパル: オブジェクト・ストレージ、コンピュート、ネットワーキング(VCNおよびサブネット)などのOCIサービスAPIをコールする場合のみ。
  7. 適切なコンパートメントで、使用するVCNおよびサブネットを選択します。
  8. 「ツールの作成」を選択します。
ヒント

次のいずれかのアクションを行います:

  • エージェントを作成する場合は、「生成AIエージェントでのエージェントの作成」に戻って、別のツールまたはエージェント・エンドポイントを作成します。
  • ツールを既存のエージェントに追加した場合、ツールがアクティブになった後で、エージェントの詳細ページから「チャットの起動」を選択して、このツールを使用してエージェントとチャットします。
  • エージェント・エンドポイントなしでエージェントを作成した場合は、エージェントを使用する準備ができたら、このエージェントのエンドポイントを作成します。
ノート

ヒューマン・レビューアがレスポンスをユーザーに送信する前にモニターおよび編集できるようにするには、エージェント・エンドポイントでオプションの「ループでヒューマンを有効にする」機能を選択します。