# Retrieval

Retrieval related APIs

## Alli Retrieval API

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

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"retrieval","description":"Retrieval related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/retrieval":{"post":{"tags":["retrieval"],"operationId":"retrievalPost","summary":"Alli Retrieval API","description":"RetrievalAPIは、Alliにアップロードされたドキュメントから質問に関連する上位Nページの情報を取得することを可能にします。このAPIはキーワード検索とセマンティック検索機能を組み合わせて、あなたのクエリに最も関連性の高いドキュメントページを提供します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string","description":"ドキュメントベースで検索する質問","required":true},"maxDocumentClues":{"type":"integer","description":"関連ページを取得する数を決定します。デフォルト値は3です。"},"bm25_score_weight":{"type":"number","format":"float","description":"これはキーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。"},"text_vector_score_weight":{"type":"number","format":"float","description":"これは文書内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。"},"title_vector_score_weight":{"type":"number","format":"float","description":"これは文書タイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"これらのハッシュタグが含まれるドキュメントのみ結果をフィルタリングしてください"},"hashtags_operator":{"type":"string","enum":["and","or"],"description":"ハッシュタグの論理演算子(デフォルトは「または」)"},"exclude_hashtags":{"type":"array","items":{"type":"string"},"description":"これらのハッシュタグを含むドキュメントを除外するために結果をフィルタリングしてください。"},"exclude_hashtags_operator":{"type":"string","enum":["and","or"],"description":"除外ハッシュタグの論理演算子(デフォルトは「または」)"},"targetFolders":{"type":"array","items":{"type":"string"},"description":"検索対象フォルダ名"},"folderIds":{"type":"array","items":{"type":"string"},"description":"検索対象のフォルダーのID"},"knowledgeBaseIds":{"type":"array","items":{"type":"string"},"description":"特定のナレッジベース内を検索するためのID"},"use_keywords":{"type":"boolean","description":"検索のためのキーワードを抽出して使用するかどうか"},"use_clue_feedback":{"type":"boolean","description":"検索結果を改善するためにフィードバックデータを使用するかどうか"}}}}}},"responses":{"200":{"description":"結果を正常に取得しました","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"ranking":{"type":"integer","description":"質問に関連するページのランク"},"title":{"type":"string","description":"質問に関連する文書のタイトル"},"text":{"type":"string","description":"質問に関連するページの内容"},"pageNo":{"type":"integer","description":"ページ番号"},"kb_id":{"type":"string","description":"ナレッジベース文書のID"}}}}}}}}},"400":{"description":"無効なパラメーター","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string"}}}}}},"500":{"description":"内部サーバーエラー","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```