# Mrcs

MRC related APIs

## ドキュメント検索　ユーザーフィードバック

> ドキュメントの検索結果に対するユーザーフィードバックを取得します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"mrcs","description":"MRC 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/mrc/user_feedback":{"post":{"tags":["mrcs"],"operationId":"registerMrcUserFeedback","summary":"ドキュメント検索　ユーザーフィードバック","description":"ドキュメントの検索結果に対するユーザーフィードバックを取得します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["answerHash","answer","id","query"],"properties":{"answerHash":{"type":"string","description":"クエリに対してフィードバックを与えるまたは削除するために利用するドキュメント検索結果のIDです。このIDはドキュメント検索が行われるたびに作成され、クエリと回答のペアに紐付けられます。上記のドキュメント情報を取得するためのAPIを使用してIDを取得できます。"},"answer":{"type":"string","description":"質問に対するドキュメントからの回答"},"id":{"type":"string","description":"抽出されたドキュメントのID"},"positive":{"type":"boolean","nullable":true,"description":"値がtrueの場合、クエリに対する回答に対して肯定的なフィードバックが与えられます。値がfalseの場合、否定的なフィードバックが与えられます。値がnullの場合、フィードバックはキャンセルされます。"},"query":{"type":"string","description":"抽出された検索結果に対してフィードバックを与えたり削除するクエリ"}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"APIリクエストが成功した後のポジティブなフィードバックの総数"},"negativeCount":{"type":"integer","description":"APIリクエストが成功した後のネガティブフィードバックの総数"}}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメント検索に対して与えられたフィードバックを取得する

> このAPIを使用することで、各検索クエリに対して、ドキュメント検索の結果（アップロードされたドキュメントからAIが抽出した回答）に対して与えられたフィードバックのリストを取得できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"mrcs","description":"MRC 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/mrc_feedbacks":{"get":{"tags":["mrcs"],"operationId":"mrcFeedbacks","summary":"ドキュメント検索に対して与えられたフィードバックを取得する","description":"このAPIを使用することで、各検索クエリに対して、ドキュメント検索の結果（アップロードされたドキュメントからAIが抽出した回答）に対して与えられたフィードバックのリストを取得できます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"オフセットを指定することで、ページ上の最初の項目のランク番号を指定することが可能です。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"limitを指定することで、1ページに返されるオブジェクトの数を設定することができます。最大値は100です。"}],"responses":{"200":{"description":"取得に成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string","description":"抽出された回答の検索クエリ。"},"feedbacks":{"type":"array","items":{"type":"object","properties":{"document_id":{"type":"string","description":"回答が抽出されたドキュメントのID。"},"answer":{"type":"string","description":"クエリに対してドキュメントから抽出された回答部分の文章。"},"answer_hash":{"type":"string","description":"検索結果としてドキュメントから抽出された回答部分のID。ドキュメント検索が行われるたびに作成され、クエリと回答ペアに結び付けられます。上記のPOST Documents APIで返却される値と同じです。"},"positive":{"type":"boolean","description":"trueまたはfalse。trueは検索結果から抽出された回答が肯定的なフィードバックを得たことを示し、falseは否定的なフィードバックを示します。"}}}}}}},"count":{"type":"integer","description":"リストされているフィードバックの総数。"}}}}}}}}}}}
```

## ドキュメント検索結果にフィードバックを与える

> このAPIを使用すると、検索クエリに対するドキュメント検索結果に付与されたフィードバックを付与または取り消すことができます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"mrcs","description":"MRC 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/mrc_feedback":{"post":{"tags":["mrcs"],"operationId":"mrcFeedback","summary":"ドキュメント検索結果にフィードバックを与える","description":"このAPIを使用すると、検索クエリに対するドキュメント検索結果に付与されたフィードバックを付与または取り消すことができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query","id","answerHash"],"properties":{"query":{"type":"string","description":"抽出された検索結果に対してフィードバックを与えるまたはキャンセルしたいクエリ。"},"id":{"type":"string","description":"答えが抽出されたドキュメントのID。"},"answerHash":{"type":"string","description":"クエリに対してフィードバックを与えたり、取り消しをしたいドキュメント検索結果のIDです。これはドキュメント検索が行われるたびに作成され、クエリと回答のペアに結び付けられます。このIDは上記のドキュメントAPIを使用して取得できます。"},"isPositive":{"type":"boolean","nullable":true,"description":"値がTrueの場合、クエリに対する抽出された答えに肯定的なフィードバックが与えられます。値がFalseの場合、否定的なフィードバックが与えられます。値がnullの場合、フィードバックが取り消されます。"}}}}}},"responses":{"200":{"description":"フィードバックが正常に送信されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"mrcFeedbackSearchResult":{"type":"object","properties":{"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"要求が処理された後の肯定的なフィードバックの合計数。"},"negativeCount":{"type":"integer","description":"リクエストが処理された後のネガティブフィードバックの総数。"}}}}}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメント履歴を問い合わせ

> 過去に行われたドキュメント検索を返しますが、それはREST APIとAlliダッシュボードの両方を通じて行われたものです。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"mrcs","description":"MRC 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/mrc_histories":{"get":{"tags":["mrcs"],"operationId":"mrcHistories","summary":"ドキュメント履歴を問い合わせ","description":"過去に行われたドキュメント検索を返しますが、それはREST APIとAlliダッシュボードの両方を通じて行われたものです。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"},"description":"クエリに表示されるべき単語。"},{"name":"order","in":"query","required":false,"schema":{"type":"string"},"description":"DESC(最新のクエリが最初に来ることを意味します)またはASC(最初のクエリが最初に来ることを意味します)のいずれかになります。"},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"},"description":"履歴を取得したい最新の日付(YYYY-MM-DDの形式である必要があります)"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"},"description":"履歴を取得したい最も過去の日付(YYYY-MM-DDの形式での日付)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"表示する結果の数の制限(ページネーションに使用)。"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"すべての結果のリストで、結果のリストを開始するインデックス(ページネーションに使用)。"}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"histories":{"type":"array","items":{"type":"object","properties":{"agent":{"type":"object","properties":{"id":{"type":"string","description":"リクエストを行った管理者のID"}}},"question":{"type":"string","description":"実際に聞かれた質問"},"answers":{"type":"array","items":{"type":"object","properties":{"knowledgeBase":{"type":"object","properties":{"id":{"type":"string","description":"回答の根拠として使用されたナレッジベースのID"},"fileName":{"type":"string","description":"回答の根拠に使用されたナレッジベースのファイル名"}}},"answer":{"type":"string","description":"回答形式の指定に従って整えられた回答内容"},"answerHash":{"type":"string","description":"参照用の答えのハッシュタグ"},"answerFormat":{"type":"string","description":"回答の形式(例:DRAFTJS)"},"hashtags":{"type":"array","items":{"type":"string"},"description":"ナレッジベースに関連するハッシュタグ"},"feedbackAvailable":{"type":"boolean","description":"この回答に対してフィードバックをできるかどうか"},"columnFilterValues":{"type":"array","items":{"type":"string"},"description":"回答に関連する任意のカラムフィルター値"}}}}}}},"count":{"type":"integer","description":"返却されたクエリ履歴の総数"}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報"}}}}}}}}}}}
```