Mrcs
MRC related APIs
ドキュメントの検索結果に対するユーザーフィードバックを取得します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
クエリに対してフィードバックを与えるまたは削除するために利用するドキュメント検索結果のIDです。このIDはドキュメント検索が行われるたびに作成され、クエリと回答のペアに紐付けられます。上記のドキュメント情報を取得するためのAPIを使用してIDを取得できます。
質問に対するドキュメントからの回答
抽出されたドキュメントのID
値がtrueの場合、クエリに対する回答に対して肯定的なフィードバックが与えられます。値がfalseの場合、否定的なフィードバックが与えられます。値がnullの場合、フィードバックはキャンセルされます。
抽出された検索結果に対してフィードバックを与えたり削除するクエリ
成功
POST /webapi/mrc/user_feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"answerHash": "text",
"answer": "text",
"id": "text",
"positive": true,
"query": "text"
}成功
{
"result": {
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
}このAPIを使用することで、各検索クエリに対して、ドキュメント検索の結果（アップロードされたドキュメントからAIが抽出した回答）に対して与えられたフィードバックのリストを取得できます。
認証用のAPIキー
オフセットを指定することで、ページ上の最初の項目のランク番号を指定することが可能です。
limitを指定することで、1ページに返されるオブジェクトの数を設定することができます。最大値は100です。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
取得に成功しました。
GET /webapi/mrc_feedbacks HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
取得に成功しました。
{
"result": [
{
"query": "text",
"feedbacks": [
{
"document_id": "text",
"answer": "text",
"answer_hash": "text",
"positive": true
}
]
}
],
"count": 1
}このAPIを使用すると、検索クエリに対するドキュメント検索結果に付与されたフィードバックを付与または取り消すことができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
抽出された検索結果に対してフィードバックを与えるまたはキャンセルしたいクエリ。
答えが抽出されたドキュメントのID。
クエリに対してフィードバックを与えたり、取り消しをしたいドキュメント検索結果のIDです。これはドキュメント検索が行われるたびに作成され、クエリと回答のペアに結び付けられます。このIDは上記のドキュメントAPIを使用して取得できます。
値がTrueの場合、クエリに対する抽出された答えに肯定的なフィードバックが与えられます。値がFalseの場合、否定的なフィードバックが与えられます。値がnullの場合、フィードバックが取り消されます。
フィードバックが正常に送信されました。
POST /webapi/mrc_feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"query": "text",
"id": "text",
"answerHash": "text",
"isPositive": true
}フィードバックが正常に送信されました。
{
"result": {
"mrcFeedbackSearchResult": {
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
},
"errors": {}
}過去に行われたドキュメント検索を返しますが、それはREST APIとAlliダッシュボードの両方を通じて行われたものです。
認証用のAPIキー
クエリに表示されるべき単語。
DESC(最新のクエリが最初に来ることを意味します)またはASC(最初のクエリが最初に来ることを意味します)のいずれかになります。
履歴を取得したい最新の日付(YYYY-MM-DDの形式である必要があります)
履歴を取得したい最も過去の日付(YYYY-MM-DDの形式での日付)
表示する結果の数の制限(ページネーションに使用)。
すべての結果のリストで、結果のリストを開始するインデックス(ページネーションに使用)。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
GET /webapi/mrc_histories HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
成功
{
"result": {
"histories": [
{
"agent": {
"id": "text"
},
"question": "text",
"answers": [
{
"knowledgeBase": {
"id": "text",
"fileName": "text"
},
"answer": "text",
"answerHash": "text",
"answerFormat": "text",
"hashtags": [
"text"
],
"feedbackAvailable": true,
"columnFilterValues": [
"text"
]
}
]
}
],
"count": 1
},
"errors": {}
}Last updated
Was this helpful?