Answer Bot API
Cognitive Search APIは、ユーザーの自由入力による問い合わせや質問に対して、機械読解(MRC)APIで該当のドキュメントから直接回答を探し出してユーザーに提示します。
Q&Aとドキュメントのアップロード
まず、Alliに利用登録をしてサインインしてください。登録時、プロジェクトタイプから必ず「Cognitive Search」を選択してください。Q&Aメニューでは質問/回答ペアを登録することができます。ワード、PDF、パワーポイント、エクセルなどドキュメントファイルは、ドキュメントメニューで登録することができます。
ドキュメントデータベースをMicrosoft OneDriveなどのデータソースと連携することもできます。ソース設定メニューで設定してください。
API経由でのドキュメントファイルアップロードについては、本ページのDocument Uploadセクションをご参照ください。
APIキーの取得
RequestヘッダーのAPI-KEY
には、割り当てられたAPIキーを入力してください。APIキーはプロジェクト設定メニューからご確認いただけます。
エンドポイントに関して
このAPIリファレンスではエンドポイントを下記として記載しております。
https://backend-ja.alli.ai
ただし、ご利用されているAlliの環境によっては下記の場合もございます。https://backend.alli.ai
どちらのエンドポイントかはプロジェクト設定メニューからご確認ください。
エージェントまたはユーザー情報をAPI利用時に用いる
特定のエンドポイントでは、リクエストヘッダーにエージェントやユーザーの情報を追加して、APIを利用することで、誰がAPIを利用したかを特定することができます。
エージェント情報
エージェント情報の場合は、リクエストヘッダーのAGENT-EMAIL
を用います。
エージェントのメール情報は、ダッシュボードの[設定] > [エージェント メニュー]で確認できます。以下に例を示します。
ユーザー情報
ユーザー情報の場合はリクエスト ヘッダーにOWN-USER-ID
を用います。ユーザー ID は新しいものでも既存のものでもかまいません。新しいユーザー ID が提供された場合、Alli はその ID で新しいユーザーを作成します。同じOWN-USER-ID
のヘッダーを持つAPI 呼び出しについては、同じユーザーからの呼び出しと見なされます。
同時にユーザーのメール アドレスを更新する場合は、USER-EMAILの
リクエスト ヘッダーでメール アドレスを指定できます。以下に例を示します。
OWN-USER-ID
には非 ASCII 文字を使用できません。ユーザー IDに非ASCII文字が含まれている場合は、IDをbase64 にエンコードして base64:CONVERTED_ID
として追加することで非ASCII文字をOWN-USER-ID
に入力することができます。
保存されたユーザー ID とメール情報は、Alli ダッシュボードの [顧客] メニューでことができます。
エラーメッセージ
予想されるresponseがない場合は、エラーメッセージを確認してください。例えば、間違ったHTTPメソッドを使用した場合、以下のような形式のエラーメッセージが戻ります。
Search from Q&A
POST
https://backend-ja.alli.ai/webapi/faq
Search from Q&A APIは、Q&Aのデータベースから質問と最も関連のあるQ&Aペアを検索して提示します。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのメール アドレスを指定することで、この API 呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
OWN-USER-ID
string
ユーザーの ID を指定することで、この API 呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの [顧客リスト]>[CUSTOMER_ID] もしくは[会話履歴]>[対話情報]にて確認できます。
USER-EMAIL
string
OWN-USER-ID を指定する際にユーザーのEメールアドレスを更新する場合は、ここで新しいEメールアドレスを指定できます。
Request Body
autoRegisterCandidates
boolean
デフォルトはtrueです。これをfalseにしますと、答えがない場合に自動でCandidatesに登録しない様になります。
hashtagsOperator
string
ANDまたはORのいずれかとなります。 結果にすべてのハッシュタグを含める場合は、ANDを選択します。 結果に少なくとも1つのハッシュタグを含める場合は、ORを選択します。
hashtags
array
検索対象に含めるハッシュタグの配列
maxResults
integer
レスポンスとして表示される結果の最大数です。
query*
string
文字列形式の検索クエリです。
format
string
html
あるいは text
です。textの場合、戻り値はplain textです。htmlの場合はhtmlで戻ります。回答にStyled htmlが含まれている場合(フォントの大きさや色など)、htmlをご使用ください。シンプルテキストの回答が必要な場合はtextを使用してください。デフォルトはhtmlとなっています。
APIは、Q&Aデータベースから最も関連性の高い質問と回答を見つけます。
confidence: AIモデルが算出したconfidence値を提示します。0と1の間の数字です。
effective confidence: クエリの結果にフィードバックが送られるとAIモデルのトレーニングに反映されますが、ユーザーとエージェントのフィードバック結果を反映したconfidence値がeffective confidenceです。0と1の間の数字です。
question: 提示された質問/回答のペアにおいて質問の部分です。
answer: 提示された質問/回答のペアにおいて回答の部分です。
id: フィードバックを入力したり、取り消すQ&Aの検索結果を特定するために使われます。
hashtags: Q&Aに登録されているハッシュタグです。
lastUpdatedDate: Q&Aが最後に更新された日時です。
agentFeedback: Q&Aに対するエージェントからのフィードバック(ダッシュボードとREST APIを介して)です。
userFeedback : Q&Aに関するユーザーからの(ユーザーとの会話からの)フィードバックです。
count: 提案されたQ&Aの数です。
hashId :このハッシュIDは、Select Answer APIを利用するときに使用されます。検索結果の表示件数は、プロジェクトの設定に従います。Q&A>設定メニューから変更することができます。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Search from Documents
POST
https://backend-ja.alli.ai/webapi/mrc
Documents APIは、複雑なテーブルなどが含まれたドキュメントからもユーザーの質問に対する回答を抽出することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのEメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの [顧客リスト]>[CUSTOMER_ID] もしくは[会話履歴]>[対話情報]にて確認できます。
USER-EMAIL
string
OWN-USER-IDを設定する際にユーザーのEメールアドレスを更新する場合は、ここで指定できます。
Request Body
returnPreview
boolean
デフォルトはfalseです。trueの場合、検索ごとにプレビューのhtmlとcssを返します。
autoRegisterCandidates
boolean
デフォルトはtrueです。これをfalseにすると、回答がない場合に自動でCandidatesに登録しないようになります。
hashtagsOperator
string
ANDまたはORのいずれかとなります。 結果にすべてのハッシュタグを含める場合は、ANDを選択してください。 結果に少なくとも1つのハッシュタグを含める場合は、ORを選択してください。
maxResults
integer
レスポンスとして表示される結果の最大数です。
query*
string
文字列形式の検索クエリです。
hashtags
array
ダッシュボードに登録したドキュメントにハッシュタグを追加することができます。ハッシュタグを活用し、当該タグが付けられたドキュメントに限定して検索することができます。
format
string
html あるいは text です。textの場合、戻り値はplain textです。htmlの場合はhtmlで戻ります。回答にstyled htmlが含まれている場合(フォントの大きさや色など)、htmlをご使用ください。シンプルテキストの回答が必要な場合はtextを使用してください。デフォルトはhtmlとなっています。
returnPdfPreview
boolean
デフォルトはfalseです。trueの場合、検索ごとにpdfPreviewのURLが発行されます。
returnPdfPreviewRawData
boolean
デフォルトはfalseです。trueの場合、検索ごとにpdfPreviewRawDataのURLが発行されます。
sortkey
String
ドキュメントのカスタムプロパティで設定するセカンダリソートキーです。
sortDirection
String
セカンダリソートの種類です。値は「asc」または「desc」になります。
検索結果は、以下のようなJSON形式で戻ります。
answer: プロジェクトにアップロードしたドキュメントから抽出された回答です。
answerHash: フィードバックを入力したり、取り消すドキュメントの検索結果を特定するために使われます。
confidence: AIモデルが算出したconfidenceの値を表示します。0と1の間の数字です。 effectiveConfidence: クエリの結果にフィードバックが送られるとAIモデルのトレーニングに反映されますが、ユーザーとエージェントのフィードバック結果を反映したconfidence値がeffective confidenceです。0と1の間の数字です。
documentId: 回答が抽出されたドキュメントのIDです。
documentName: 回答が抽出されたドキュメントの名前です。
hashtags: ドキュメントに登録されているハッシュタグです。
pageNo: 回答が得られたドキュメントのページ番号(プレビュー時ページ番号)です。createdDate: ドキュメントがアップデートされた日時です。
agentFeedback: ドキュメントに対するエージェントからのフィードバック(ダッシュボードとREST APIを介して)です。
userFeedback:ドキュメントに関するユーザーからのフィードバックとなります。検索結果の数と閾値は、ダッシュボードの設定に従います。[ナレッジベース]>[ドキュメント]> [設定]で設定を確認してください。
body:リクエストパラメーターのreturnPreviewがtrueの場合、ドキュメント検索プレビューのhtml本文が表示されます。
css:リクエストパラメーターでreturnPreviewがtrueの場合、ドキュメント検索プレビューのcssが表示されます。
pdfPreview:リクエストでreturnPdfPreviewがtrueの場合、回答が強調表示されたドキュメントのPDFプレビューへのURLが表示されます。 [IP許可リストのダウンロード]設定を使用してURLを制限できることに注意してください。 検索結果の数としきい値は、ダッシュボードの設定に従います。 [ドキュメント]> [設定]で設定を確認してください。
folder:もし回答がDocumentsデータベース内のフォルダから見つかった場合、ここにはフォルダ名が返されます。
editer:ドキュメントへの編集アクセス権を持つエージェントのメールアドレスの一覧が返されます。(Alliのダッシュボードで設定されている場合)
viewer:ドキュメントへの閲覧アクセス権を持つエージェントのメールアドレスの一覧が返されます。(Alliのダッシュボードで設定されている場合) 検索結果の数と閾値は、ダッシュボードの設定に従います。ドキュメント > 設定で設定を確認してください。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Get Single Q&A
GET
https://backend-ja.alli.ai/webapi/single_faq
このAPIを利用すれば特定のQ&Aの詳細を取得することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュー→全般タブから確認できます。
Request Body
id*
string
詳細取得の対象となるQ&AのIDです。
format
string
html あるいは text です。textの場合、戻り値はplain textです。htmlの場合はhtmlで戻ります。回答にStyled htmlが含まれている場合(フォントの大きさや色など)、htmlをご使用ください。シンプルテキストの回答が必要な場合はtextを使用してください。デフォルトはhtmlとなっています。
検索結果は、以下のようなJSON形式で戻ります。
question: 対象となるQ&Aの質問です。
answer : 対象となるQ&Aの回答です。
id: 対象となるFAQのIDです。Requestで使用したものと同じ値です。
userFeedback: 対象となるQ&Aに対するユーザーフィードバックです。
agentFeedback: 対象となるQ&Aに対するエージェントフィードバックです。
lastUpdatedDate, createdDate: 対象となるQ&Aの更新日と作成日です。
hashtags: 対象となる質問に付与された全てのハッシュタグです。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Get Single Document
GET
https://backend-ja.alli.ai/webapi/single_document
このAPIを利用すれば特定のドキュメントの詳細を取得することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュー→全般タブから確認できます。
Request Body
id*
string
ドキュメントのidです。
検索結果は、以下のようなJSON形式で戻ります。
id:ドキュメントのidです。
documentName:ドキュメントファイルの名称です。
createDate:ドキュメントがアップロードされた日付です。
hashtags:ドキュメントに紐づけられたハッシュタグです。
agentFeedback:ドキュメントに対してエージェントからフィードバックされたgood/Badそれぞれの数です。
userFeedback:ドキュメントに対してユーザーからフィードバックされたgood/Badそれぞれの数です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Q&A Feedbacks
GET
https://backend-ja.alli.ai/webapi/faq_feedbacks
このAPIを使用すれば、検索クエリごとにQ&Aペアに与えられるフィードバックリストを得ることができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
aaaエージェントのメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの[設定]>[エージェント]にて確認してください。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの[顧客リスト]>[CUSTOMER_ID]もしくは[会話履歴]>[対話情報]にて確認できます。
Request Body
offset
integer
ページに出力される第一項目の位置を決めます。
limit
integer
1ページに出力する項目の数を決めます。最大値は100です。
検索結果は、以下のようなJSON形式で戻ります。
query: 以下のQ&Aに対し、フィードバック情報を持っている検索クエリです。
feedbacks: 当該クエリに従属したフィードバック情報です。
faq_idとpositiveを含みます。
faqId: 当該クエリに対し、フィードバックが与えられたQ&AのIDです。
positive: true あるいは false です。trueはQ&Aに対するポジティブなフィルタリング、falseはネガティブなフィードバックを意味します。
count: リスト化したフィードバックの数です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
特定のユーザーからフィードバックリストを取得する場合は、ヘッダーにOWN-USER-IDを指定してください。特定のエージェントからフィードバックリストを取得する場合は、ヘッダーにAGENT-EMAILを指定してください。OWN-USER-IDまたはAGENT-EMAILを指定しない場合、すべてのフィードバックが返されます。
Response Example
Q&A Feedback
POST
https://backend-ja.alli.ai/webapi/faq_feedback
このAPIを利用すれば、検索クエリごとにQ&Aにフィードバックを与えたり、与えられたフィードバックを削除することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのEメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
Request Body
query*
string
当該FAQにフィードバック情報を与えたり、取り消す検索クエリです。
id*
string
フィードバック情報を与えたり、取り消すFAQのIDです。検索する際、検索クエリと結果のQ&Aペアに対して与えられ、上記のPOST Q&A APIを利用して抽出することができます。
isPositive*
boolean
trueであればポジティブなフィードバック、falseであればネガティブなフィードバックを与えます。nullは与えられたフィードバックを取り消します。
検索結果は、以下のようなJSON形式で戻ります。
id: フィードバック情報を与えたり、取り消したQ&AのIDです。
Requestで使用したものと同じ情報です。
positiveCount: Requestの処理後のポジティブなフィードバック数の合計です。
negativeCount: Requestの処理後のネガティブなフィードバック数の合計です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Q&A_IDを該当するQ&A IDに変更しなければなりません。Q&A IDを取得するには、Q&AのResponse Example もしくはQ&A FeedbacksのResponse Exampleの項目をご参照ください。
Response Example
Q&A User Feedback
POST
https://backend-ja.alli.ai/webapi/faq/user_feedback
このAPIを利用すると、対象のFAQに対してユーザーフィードバックを登録することができます。 (ユーザーフィードバックは、Alliチャットボットを使用して回答に対して適切か不適切をユーザーが送信するものです)。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの [顧客リスト]>[CUSTOMER_ID] もしくは[会話履歴]>[対話情報]にて確認できます。
USER-EMAIL
string
OWN-USER-IDを設定する際にユーザーのEメールアドレスを更新する場合は、ここで指定できます。
Request Body
prev
boolean
このクエリを割り当てた以前のフィードバックに関するブール値(以前のフィードバックを変更するためにのみ使用する必要があります)
positive*
boolean
登録するフィードバックが適切か不適切かのブール値
query*
string
当該FAQにフィードバック情報を与えたり、取り消す検索クエリです。
id*
string
フィードバック情報を与えたり、取り消すFAQのIDです。検索する際、検索クエリと結果のQ&Aペアに対して与えられ、上記のPOST Q&A APIを利用して抽出することができます。
analyticsHashtags
array
ハッシュタグのスコープとして登録したすべてのハッシュタグの配列です。ハッシュタグによる分析で使用されます。
対象のFAQに対する現在のユーザーフィードバック(positiveCountとnegativeCountの両方)を返します。
Request Example
Response Example
Upload Q&As
POST
https://backend-ja.alli.ai/webapi/upload_faq_file
この API を使用することで、tsv、csv、xlsx、および zip 形式で複数の Q&A をアップロードできます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
この API 呼び出しを行うエージェントを指定する場合は、ここでエージェントのメール アドレスを指定できます。これは、ダッシュボードの [設定] > [エージェント] の下にあります。
Request Body
file*
string
ローカルの Q&A ファイルの場所。 xlsx、tsv、csv、および zip ファイルがサポートされています。
result:アップロード成功時にsuccessと表示します。
notUploaded:質問のいずれかがアップロードされていないか、既存のQ&Aが更新されていない場合、詳細がここにリストされます。
question: アップロードされていないまたは更新されていないQ&AのQの部分になります。state:Q&Aが「類似の質問」の内容の重複によりアップロードされていない場合は「dup」、同じ質問内容により既存のQ&Aが更新された場合は「up」と表示されます。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Add Q&A
POST
https://backend-ja.alli.ai/webapi/register_faq
このAPIを使用することで、新しいQ&Aを追加したり、既存のQ&Aを更新することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのEメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
Request Body
status
string
ONもしくはOFFとなります。ONの場合は、Q&A検索にて検索対象のQ&Aとなります。
question*
string
Q&Aの質問部分となります。
similarQuestions
string
類似質問を指します。類似質問として複数を追加できます。
answer*
string
Q&Aの回答部分です。同じ質問が質問がデータベースに存在する場合は既存の回答はこの回答部分に置き換わります。
hashtags
array
Q&Aに設定できるハッシュタグです。複数のハッシュタグを設定できます。
memo
string
エージェントにて確認できるQ&Aにおけるメモを指します。
followFolderPermission
boolean
アップロード時に所属所属するフォルダがある場合、そのフォルダの権限を引き継ぐかどうかを指定します(デフォルト値: True)。引き継がない場合、以下で指定された権限が使用されます。それ以外の特別な指定がない限り、すべてのエージェントとユーザーに権限が与えられます。
agentEditor
array
ファイルの編集権限を持つエージェントを登録してください。
agentViewer
array
ファイルの閲覧権限を持つエージェントを登録してください。
userViewer
object
ファイルの閲覧権限を持つユーザーを登録してください。customer_idを使用する場合は、own-user-idと同じです。customer_groupのid(categoryElementsId)は、CUSTOMER GROUPの問い合わせAPIを使用して取得できます。
allowOtherAgentsView
boolean
編集者/閲覧者リストに含まれていないエージェントも閲覧することができます。
allowOtherUsersView
boolean
編集者/閲覧者リストに含まれていないユーザーも閲覧することができます。
status: 登録されたQ&Aのステータスです。「created」とはQ&Aが新しく登録されたことを指します。また、「updated」は既存のQ&Aが新しい回答で更新されたことを指します。
id: 登録されたQ&AのIDを指します。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
delete Q&A
POST
https://backend-ja.alli.aiwebapi/delete_faq
このAPIを使用することで、Q&Aを削除することができます。
Path Parameters
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
Request Body
id*
string
削除したいQ&AのIDとなります。
status:Q&Aが正常に削除された場合は「deleted」となります。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
List Q&As
GET
https://backend-ja.alli.ai/webapi/faqs
このAPIを使用することで、ナレッジベースのQ&Aを一覧で取得することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
Request Body
SearchTerm
string
取得するQ&Aをフィルタリングするためのキーワード検索クエリです
isUsed
boolean
trueの場合、オンになっているQ&Aのみがリストされ、falseの場合、オフになっているQ&Aのみが取得されます。
hashgtags
array
取得するQ&Aをフィルタリングするためのハッシュタグを指定できます。複数のハッシュタグを指定できます。
hashtagsOperator
string
and
またはor
のいずれかとなります。結果にすべてのハッシュタグを含める場合は、and
を選択してください。結果に少なくとも1つのハッシュタグを含める場合は、or
を選択してください。
createdByAgent
string
trueの場合、リストにはエージェントによって作成されたQ&Aのみが含まれます。 falseの場合、他のQ&Aのみが含まれます。 createdByAgent、answeredByMrc、autoGenerated、editedByAgentフィルターは相互に排他的であり、それらが2つ以上使用される場合はORロジックが適用されることに注意してください。
answeredByMrc
string
trueの場合、リストには、アップロードされたドキュメントから回答が自動的に抽出されるQ&Aのみが含まれます。 falseの場合、他のQ&Aのみが含まれます。
autoGenerated
string
trueの場合、リストには自動生成されたQ&Aのみが含まれます。 falseの場合、他のQ&Aのみが含まれます。
editedByAgent
string
trueの場合、リストには、登録後にエージェントが編集したQ&Aのみが含まれます。 falseの場合、それ以外のQ&Aのみが含まれます。
format
string
html
あるいは text
です。textの場合、戻り値はplain textです。htmlの場合はhtmlとなります。回答にStyle htmlが含まれている場合(フォントの大きさや色など)、htmlをご使用ください。シンプルなテキストが必要な場合はtextを使用してください。デフォルトはhtmlとなります。
offset
integer
オフセットを使用することで、表示するQ&Aの最初のインデックスを指定できます。
limit
integer
limitを使用することで、1ページに返されるオブジェクトの数を設定できます。最大値とデフォルト値は1000です。
offset:リクエストパラメーターとしてのoffsetと同じ値となります。
count:limitが適用された際に取得されたQ&Aの総数。
totalCount:適用されたフィルターの結果としてのQ&Aの総数。
id:Q&AのID。
question:Q&Aの質問部分。
answer:Q&Aの回答部分。
hashtags:Q&Aに設定されているハッシュタグ。
userFeedback:肯定的および否定的なユーザーフィードバックの数。ユーザーのフィードバックは、将来のクエリの検索結果に影響します。
agentFeedback:正および負のエージェントフィードバックの数。エージェントのフィードバックは、将来のクエリの検索結果に影響します。
lastUpdatedDate:Q&Aが最後に更新された日付。
createdDate:Q&Aが作成された日付。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Q&A Candidates
GET
https://backend-ja.alli.ai/webapi/faq_candidates
このAPIを利用すれば、ユーザーからの質問の中で回答されていない質問、つまり、「未回答質問」のリストを得ることができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
Request Body
hashtags
array
当該ハッシュタグが付いている未回答質問のみ確認できるようにするarrayです。
searchTerm
string
確認する未回答質問をフィルタリングするための検索クエリです。
order
string
未回答質問を並べる基準を意味します。属性_[DESC or ASC]形式で構成され、属性にはFREQUENCYとCREATEDATがあります。
state
string
確認する未回答質問のステータスです。ALL、ACTIVE、 ARCHIVEDのうち一つの値を持ちます。
offset
integer
ページに出力される第一項目の位置を決めます。
limit
integer
1ページに出力する項目の数を決めます。最大値は100です。
sources
array
指定したソースに検索範囲を制限する場合に使用するソース配列です。SDK、QNA、DOCUMENTS、APIをソースとして使用できます。
検索結果は、以下のようなJSON形式で戻ります。
count: リスト化した未回答質問の合計件数です。
id: 未回答質問に対して抽出された回答のIDです。新しい未回答質問が登録されると、Alliはアップロードしたドキュメントから自動的に回答を抽出して登録を試みます。
frequency: questions の下にある全てのfrequency 値の合計です。
textAnswer: 未回答質問に対して自動抽出された回答の内容です。
state: 未回答質問のステータスです。Q&Aデータベースに追加されていない場合はACTIVE、追加された場合はARCHIVEDで表示されます。
createdAt: 未回答質問が生成された日時です。
questions: 複数の類似質問が同一の回答を共有することができますが、同じ回答を共有する全ての未回答質問の情報をここで確認することができます。
id (under questions): 未回答のユーザー質問のIDです。
question (under questions): 未回答のユーザー質問の内容です。
frequency (under questions): ユーザーが同じ質問を何回したか表示します。
id (under history): 未回答質問のヒストリー情報に割り当てられたIDです。ヒストリー情報はユーザーが当該質問をした時のログ情報です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Q&A Candidates
POST
https://backend-ja.alli.ai/webapi/add_faq_candidates
未回答の質問リストに未回答の質問を新たに登録します。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのEメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの [顧客リスト]>[CUSTOMER_ID] もしくは[会話履歴]>[対話情報]にて確認できます。
USER-EMAIL
string
OWN-USER-IDを設定する際にユーザーのEメールアドレスを更新する場合は、ここで指定できます。
Request Body
queries*
string
登録したいすべてのクエリのリスト
結果は次の JSON 形式で取得されます。
id: 登録された未回答の質問のID。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
Response Example
Documents Feedbacks
GET
https://backend-ja.alli.ai/webapi/mrc_feedbacks
このAPIを使用すれば、検索クエリごとにドキュメントから抽出された回答に与えられるフィードバックリストを得ることができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するメールアドレスは、ダッシュボードの[設定]>[エージェント]にて確認してください。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定したIDは、ダッシュボードの[顧客リスト]>[CUSTOMER_ID]もしくは[会話履歴]>[対話情報]にて確認できます。
Request Body
offset
integer
ページに出力される第一項目の位置を決めます。
limit
integer
1ページに出力する項目の数を決めます。最大値は100です。
検索結果は、以下のようなJSON形式で戻ります。
query: 以下の回答が抽出された検索クエリです。
documentId: 回答を抽出したドキュメントのIDです。
answer: 当該クエリに対してドキュメントから抽出された回答の内容です。
answerHash: 当該クエリに対してドキュメントから抽出された回答に与えられるIDの値です。Documents検索をした時、クエリと検索結果のペアに与えられる値であり、上記のPOST Documents APIを利用して得られるものと同じ値です。
positive: true あるいは false です。trueは当該回答に対するポジティブなフィードバック、falseはネガティブなフィードバックを意味します。
count: リスト化したフィードバック件数の合計です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
特定のユーザーからフィードバックリストを取得する場合は、ヘッダーにOWN-USER-IDを指定してください。特定のエージェントからフィードバックリストを取得する場合は、ヘッダーにAGENT-EMAILを指定してください。
Response Example
Documents Search Feedback
POST
https://backend-ja.alli.ai/webapi/mrc_feedback
このAPIを使用すれば、検索クエリによって抽出された検索結果に対してフィードバックをしたり、削除することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
AGENT-EMAIL
string
エージェントのEメールアドレスを指定することで、このAPI呼び出しを行うエージェントを特定できます。ここで指定するEメールアドレスは、ダッシュボードの [設定] > [エージェント] にて確認してください。
Request Body
query*
string
Documentsの検索結果にフィードバック情報を与える検索クエリです。
id*
string
回答が抽出されたドキュメントのIDです。
answerHash*
string
当該クエリに対してドキュメントから抽出された回答に与えられるIDの値です。Documents検索をした時にクエリと検索結果のペアに与えられる値であり、上記のPOST Documents APIを利用して得ることができます。
isPositive*
boolean
trueであれば当該クエリに対する検索結果にポジティブなフィードバック、falseであればネガティブなフィードバックを与えます。nullの場合は与えられたフィードバックを取り消します。
検索結果は、以下のようなJSON形式で戻ります。
positivecount: Requestの処理後のポジティブなフィードバック数の合計です。
negativecount: Requestの処理後のネガティブなフィードバック数の合計です。
Request Example
YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。
DOCUMENT_IDとANSWER_HASHの部分を該当するIDに変更しなければなりません。それぞれの情報を得るにはDocumentsのResponse Example項目、もしくはDocuments FeedbacksのResponse Exampleの項目をご参照ください。
Response Example
Documents Search User Feedback
POST
https://backend-ja.alli.ai/webapi/mrc/user_feedback
このAPIを利用すると、ドキュメント検索の結果に対してユーザーフィードバックを登録することができます。
Headers
API-KEY*
string
割り当てられたAPIキーです。プロジェクト設定メニュ→全般タブから確認できます。
OWN-USER-ID
string
ユーザーのIDを指定することで、このAPI呼び出しを行うユーザーを特定できます。ここで指定するIDは、ダッシュボードの [顧客リスト]>[CUSTOMER_ID] もしくは[会話履歴]>[対話情報]にて確認できます。
USER-EMAIL
string
OWN-USER-IDを設定する際にユーザーのEメールアドレスを更新する場合は、ここで指定できます。
Request Body
anserHash*
string
当該クエリに対してドキュメントから抽出された回答に与えられるIDの値です。Documents検索をした時、クエリと検索結果のペアに与えられる値であり、上記のPOST Documents APIを利用して得られるものと同じ値です。
id*
string
ドキュメント検索の回答が抽出されたドキュメントのIDです。
positive*
boolean
登録するフィードバックが適切か不適切かのブール値です。
query*
string
文字列形式の検索クエリです。
analyticsHashtags
array
ハッシュタグをスコープとして登録し、ハッシュタグによる分析で使用するためのハッシュタグの配列です。
変更後のユーザーフィードバックのpositiveCountとnegativeCountをレスポンスとして返します。