Retrieval

Retrieval related APIs

Alli Retrieval API

post

RetrievalAPIは、Alliにアップロードされたドキュメントから質問に関連する上位Nページの情報を取得することを可能にします。このAPIはキーワード検索とセマンティック検索機能を組み合わせて、あなたのクエリに最も関連性の高いドキュメントページを提供します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

questionstringOptional

ドキュメントベースで検索する質問

maxDocumentCluesintegerOptional

関連ページを取得する数を決定します。デフォルト値は3です。

bm25_score_weightnumber · floatOptional

これはキーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。

text_vector_score_weightnumber · floatOptional

これは文書内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。

title_vector_score_weightnumber · floatOptional

これは文書タイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。

hashtagsstring[]Optional

これらのハッシュタグが含まれるドキュメントのみ結果をフィルタリングしてください

hashtags_operatorstring · enumOptional

ハッシュタグの論理演算子(デフォルトは「または」)

Possible values:

exclude_hashtagsstring[]Optional

これらのハッシュタグを含むドキュメントを除外するために結果をフィルタリングしてください。

exclude_hashtags_operatorstring · enumOptional

除外ハッシュタグの論理演算子(デフォルトは「または」)

Possible values:

targetFoldersstring[]Optional

検索対象フォルダ名

folderIdsstring[]Optional

検索対象のフォルダーのID

knowledgeBaseIdsstring[]Optional

特定のナレッジベース内を検索するためのID

use_keywordsbooleanOptional

検索のためのキーワードを抽出して使用するかどうか

use_clue_feedbackbooleanOptional

検索結果を改善するためにフィードバックデータを使用するかどうか

Responses

200

結果を正常に取得しました

application/json

400

無効なパラメーター

application/json

500

内部サーバーエラー

application/json

post

/webapi/retrieval

HTTPcURLJavaScriptPython

POST /webapi/retrieval HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "question": "text",
  "maxDocumentClues": 1,
  "bm25_score_weight": 1,
  "text_vector_score_weight": 1,
  "title_vector_score_weight": 1,
  "hashtags": [
    "text"
  ],
  "hashtags_operator": "and",
  "exclude_hashtags": [
    "text"
  ],
  "exclude_hashtags_operator": "and",
  "targetFolders": [
    "text"
  ],
  "folderIds": [
    "text"
  ],
  "knowledgeBaseIds": [
    "text"
  ],
  "use_keywords": true,
  "use_clue_feedback": true
}

{
  "result": [
    {
      "ranking": 1,
      "title": "text",
      "text": "text",
      "pageNo": 1,
      "kb_id": "text"
    }
  ]
}