Alli Retrieval API
Retrieval APIを使用すると、Alliにアップロードされているドキュメントの中から、質問に関連するページ情報のトップNを取得できます。
POST https://backend-ja.alli.ai/webapi/retrieval
Parameters
Request Body
question*
string
質問文の文字列です。
max_document_clues
integer
質問に関連するページをいくつインポートするかを設定します。 デフォルト値は 3 です。
bm25_score_weight (optional)
float
キーワード検索の重みを設定します。 その値が高いほど、キーワードスコアが検索に反映されます。 0〜9までの値で設定してください。 0はキーワード検索を使用しないことを意味します。 デフォルト値は 9 です。
text_vector_score_weight (optional)
float
文書の内容に対するセマンティック検索の重みを設定します。
その値が高いほど内容に対するセマンティック検索の結果が反映されます。 同様に、0〜9の値が設定できます。
0は文書コンテンツのセマンティック検索を使用しないことを意味します。 デフォルト値は 1 です。
title_vector_score_weight (optional)
float
文書タイトルに対するセマンティック検索の重みを設定します。
同様に、0〜9の値が設定できます。 0は文書タイトルのセマンティック検索を使用しないことを意味します。 デフォルト値は 0 です。
リクエストを送信して成功すると、JSONで結果を取得できます。
ranking : 質問に関連するページのランク
title : 質問に関連するドキュメントのタイトル
text : 質問に関するドキュメントのページ内容
page_no : ページ番号
備考
キーワード検索
ドキュメントの内の文章をトークンに分割し、ワードが質問文と一致するかをスコアリングする方法です。
セマンティック検索
ドキュメントの内の文章を埋め込みベクトルに変換して、質問との類似度をスコアリングする方法です。同義語にも対応可能な検索方法です。
関連検索についてはこちらのブログ記事で詳しく説明しています。
応答例
APIキーを利用する際は、REST API KEYをプロジェクトのAPIキーに置き換える必要があります。
APIキーはダッシュボードの[プロジェクト設定]＞[全般]タブにございます。
詳しくはこちら
ここでは例文をもとに応答例を記載します。
Response Example
Last updated
Was this helpful?