カスタム・コンテンツ・サービスへの接続

オンラインで編集する

内部データベース、プライベートAPI、独自のドキュメントストアなど、ネイティブにサポートされていない外部システムにデータが保存されている場合は、カスタムサービスリポジトリを使用します。 カスタムサービスでは、フィルタリング、フォーマット、アクセスルールなど、エージェントがデータを取得する方法を完全に制御できます。

このセットアップは、ファイアウォールの背後にあるようなセキュアな環境もサポートし、エージェントに到達する前に検索結果の前処理を可能にする。

カスタムサービスは、環境やセキュリティ要件に応じて、サーバー側またはクライアント側のいずれかでホストすることができます。

詳細については、 「設定手順」 をご覧ください

カスタム・サービス・リポジトリへのアクセス

エージェントをカスタムサービスリポジトリに接続し、実行時にドキュメント検索を可能にします。 この接続により、エージェントが組織の外部コンテンツに基づいてレスポンスを取得することができます。

データがプライベートな環境に保存されている場合、カスタムフィルタが必要な場合、またはユーザーに表示する前に特定のアクセスルールや変換を通過する必要がある場合は、カスタムサービスを使用できます。

別の知識ソースがすでに接続されている場合、「 知識＋を選択 」ボタンは表示されません。 ソースを切り替えるには、 Change source > Select your new source > I understandをクリックします。 ソースを変更すると、以前のリポジトリの詳細やファイルが削除され、復元できなくなります。

  1. Knowledge セクションで、 Choose knowledge +をクリックする。

  2. ソースの選択 ]で[ カスタムサービス]> [ 次へ] をクリックします。

  3. で URL に、カスタム・サービス・リポジトリのエンドポイント URL を入力します。

  4. Choose an authentication type 」で、3つのオプションのいずれかを選択する：

    • 基本認証 ： Basic authentication を選択した場合、ユーザー名とパスワードを入力する必要があります。

    • APIキー ： API Key を選択した場合は、カスタムサービスリポジトリのAPIキーを指定する必要があります。

    • None : None を選択した場合は、 Next をクリックします。

  5. Next をクリックして、リポジトリを設定します。

手順に従って、カスタム・サービス接続のデフォルト・ フィルターとメタデータを設定してください：

  1. デフォルトフィルター ：カスタムサービスに送信されるデフォルトの入力値を入力します。 これは、プレーンテキスト、JSON、またはその他のサポートされているフォーマットである。

  2. メタデータ ：サービスの追加コンテキストやパラメータを定義するために、JSON形式のメタデータを提供する。

  3. 次へ」をクリックして進みます。

  4. ナレッジの詳細セクションで

    • 名前 ］には、ナレッジ・ソースの表示名を入力します。

    • 説明］には、ナレッジ・ソースの簡単な説明を入力します。 詳細については、 「知識記述の作成」 を参照してください。

  5. 保存 をクリックします。

カスタムサービス設定の管理

カスタムサービス設定を更新するには

  1. Knowledge セクションで、 Settingsをクリックする。

  2. 設定] または[ インスタンス] タブの値を変更します。

  3. Save をクリックして変更を適用します。

カスタムサービス・コンテンツ・リポジトリの削除

カスタムコンテンツリポジトリを削除するには

  1. 知識」 セクションに移動し、「 設定」をクリックする。

  2. インスタンスタブを開く。

  3. 「削除」をクリックします。

カスタムサービスのための検索システムの設定

検索統合でカスタムサービスを使用するには、特定のレスポンススキーマで結果を返すサーバーを提供する必要があります。 これにより、ナレッジツールとの互換性が確保される。 検索スキーマがエージェントスキーマと一致する場合は、それを直接使用することができます。 そうでなければ、あなたのスキーマをエージェントのスキーマにマッピングするラッパーが必要になる。 このラッパーは、サービスとしてデプロイすることも、チャット・クライアントから起動することもできます。 ラッパーは、非準拠のソース、ライブラリ、サービスを統合するときに便利である。

カスタムサービスの取得用サーバーの設定

カスタムサービスの取得用サーバーを設定するには、 『セットアップガイド』 を参照してください。 カスタムサービス検索用サーバーは、以下のAPIを実装する必要がある：

照会：POST <server_url>

要求

{
    "query": "<QUERY>",
    "filter": "<FILTER>", // optional
    "metadata": {
        // optional, you can fill any information here
    }
}

応答

{
    
  "search_results": [
    {
      "result_metadata": { // optional
        "score": <SCORE as a number>
      },
      "title": "<TITLE>",
      "body": "<BODY>",
      "url": "<URL>", // optional
      "highlight": { // optional, will be used instead of "body" for Conversational Search if provided
        "body": [
          "<HIGHLIGHT1>",
          "<HIGHLIGHT2>",
           ...
        ]
      }
    }
  ]

}
重要:

リクエスト内のメタデータおよびレスポンスオブジェクト全体のサイズは、100 KBを超えてはなりません。