Faqs
FAQ related APIs
特定のFAQをユーザーが選択したものとして処理することができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
選択したいQ&AのID
Q&A検索結果のID
選択されたQ&A
無効なQ&Aです
POST /webapi/faq/select_answer HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"id": "text",
"hashId": "text"
}{
"result": "text"
}このAPIを使用すると、Q&Aナレッジベースから最も関連性の高い質問と回答のペアを見つけることができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
デフォルト値はtrueです。このオプションをfalseに設定すると、指定されたクエリに対して答えがない場合、自動的にQ&A登録候補にクエリが登録されません。
ANDまたはORのいずれかを選択します。
すべてのハッシュタグを含む結果を返したい場合はANDを選択します。
少なくとも1つのハッシュタグを含む結果を返したい場合はORを選択します。
表示したいすべてのハッシュタグの配列。
返される結果の最大数。
質問内容。
html またはテキストの場合。テキストの場合、返り値はプレーンテキストになります。html の場合、html を返します。異なるフォントサイズや色などのスタイルがある html を使用する場合、html を使用できます。単にテキストとして答えを得たい場合は、テキストを使用できます。デフォルト値は html です。
APIは、Q&Aデータから最も関連性の高い質問と回答を見つけます。
POST /webapi/faq HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"autoRegisterCandidates": true,
"hashtagsOperator": "AND",
"hashtags": [
"text"
],
"maxResults": 1,
"query": "text",
"format": "html"
}APIは、Q&Aデータから最も関連性の高い質問と回答を見つけます。
{
"result": [
{
"confidence": 1,
"effectiveConfidence": 1,
"question": "text",
"answer": "text",
"id": "text",
"hashtags": [
"text"
],
"lastUpdatedDate": "2025-12-07",
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
],
"count": 1,
"hashId": "text"
}シングルQ&Aのすべての詳細を取得する方法です。
認証用のAPIキー
お探しのFAQのID。
このFAQの回答値の形式。デフォルトはHTMLです。
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
FAQの詳細を正常に取得しました。
FAQが見つかりません
GET /webapi/single_faq?id=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"question": "text",
"similar_questions": [
"text"
],
"answer": "text",
"id": "text",
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-12-07",
"createdDate": "2025-12-07",
"hashtags": [
"text"
],
"statusOnAt": "2025-12-07T07:14:16.210Z",
"statusOffAt": "2025-12-07T07:14:16.210Z",
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
],
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}
}ナレッジベースのQ&Aを一覧表示できます。
認証用のAPIキー
オフセットを使用すると、ページ上の最初の項目のランク番号を指定できます。
01ページあたりに返されるオブジェクトの数を設定できます。最大値およびデフォルト値は1000です。
1000回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式でも可能です。
htmlPossible values: 任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
GET /webapi/faqs HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
成功
{
"offset": 1,
"count": 1,
"total_count": 1,
"results": [
{
"id": "text",
"question": "text",
"answer": "text",
"hashtags": [
"text"
],
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-12-07",
"createdDate": "2025-12-07"
}
]
}ナレッジベース内のQ&Aの検索およびフィルタリングができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
リストを絞り込むためのキーワード検索クエリです。以下の方法で高度な検索が可能です。を使用できます。ANDの場合は"TERM1 TERM2"、ORの場合は"TERM1 OR TERM2"、完全一致の場合は"TERM"を使用します。
Trueの場合、有効になっているQ&Aのみが一覧表示されます。Falseの場合、無効になっているQ&Aのみが一覧表示されます。
リストをフィルタリングするためのハッシュタグ。複数のハッシュタグを追加できます。
「AND」の場合、ハッシュタグのフィルターは複数のハッシュタグに対してANDロジックで機能します。「OR」の場合、ORロジックで機能します。
Trueの場合、リストには管理者によって作成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。createdByAgent、answeredByMrc、autoGenerated、editedByAgentの各フィルターは互いに排他的です。これらを2つ以上同時に指定した場合は、OR条件として扱われます。
Trueの場合、ドキュメントから自動抽出されたQ&Aのみ、Falseの場合、その他のQ&Aのみを返します。
Trueの場合、リストには自動生成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。
Trueの場合、リストには登録後にエージェントによって編集されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。
回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式を使用できます。デフォルト値はHTMLです。
オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。
1ページに返されるオブジェクトの数を設定します。最大値およびデフォルト値は1000です。
成功
POST /webapi/faqs HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"searchTerm": "text",
"isUsed": true,
"hashtags": [
"text"
],
"hashtagsOperator": "and",
"createdByAgent": true,
"answeredByMrc": true,
"autoGenerated": true,
"editedByAgent": true,
"format": "html",
"offset": 1,
"limit": 1
}成功
{
"offset": 1,
"count": 1,
"total_count": 1,
"results": [
{
"id": "text",
"question": "text",
"answer": "text",
"hashtags": [
"text"
],
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-12-07",
"createdDate": "2025-12-07"
}
]
}新規のQ&Aの追加や既存のQ&Aの更新ができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Q&Aの質問部分
類似質問
Q&Aの答えの部分です。同じ質問が既にナレッジベースにに存在する場合、答えが置き換えられます。
Q&Aにハッシュタグを追加します。
Q&AのON/OFFを設定します。ONにすると、登録したQ&Aが有効になります。
Q&Aのメモ
成功
POST /webapi/register_faq HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"question": "text",
"similarQuestions": [
"text"
],
"answer": "text",
"hashtags": [
"text"
],
"status": true,
"memo": "text",
"target_folder_id": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}成功
{
"result": {
"status": "text",
"id": "text"
},
"errors": "text"
}既存のQ&Aを更新できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
更新するQ&AのID
Q&Aの質問部分
類似質問
Q&Aの答えの部分
Q&Aにハッシュタグを追加
Q&AのON/OFFを切り替えます。ONにすると、Q&Aが有効になります。
成功
PUT /webapi/register_faq HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191
{
"id": "text",
"question": "text",
"similar_questions": [
"text"
],
"answer": "text",
"hashtags": [
"text"
],
"status": true,
"target_folder_id": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}成功
{
"result": {
"status": "text",
"id": "text"
},
"errors": "text"
}このAPIを使用してQ&Aを削除できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
削除したいQ&AのID。
FAQが正常に削除されました。
Q&Aデータが見つかりません
POST /webapi/delete_faq HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}{
"result": {
"status": "text"
},
"errors": "text"
}このAPIを使用することで、tsv、csv、xlsx、zip形式で複数のQ&Aをアップロードすることができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ローカルに保存されているQ&Aファイルの場所。xlsx、tsv、csv、およびzipファイルがサポートされています。
FAQファイルのアップロードに成功しました。
無効なパラメータです。
POST /webapi/upload_faq_file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"result": "text",
"notUploaded": [
{
"question": "text",
"state": "text"
}
]
}このAPIは、クエリによって検索されたQ&Aに対して「フィードバックを付与する / 取り消す」ためのものです。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
フィードバックを付与または取り消したい Q&A に紐づいている質問文。
そのQ&Aを識別するID。これはQ&A検索APIを実行した際のレスポンスから取得できます。
フィードバック内容:true → ポジティブフィードバック(肯定)、false → ネガティブフィードバック(否定)、null → フィードバックの取り消し
フィードバックが正常に送信されました
POST /webapi/faq_feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"query": "text",
"id": "text",
"isPositive": true
}フィードバックが正常に送信されました
{
"result": {
"faqTrainSearchResult": {
"faq": {
"id": "text"
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
},
"errors": {}
}過去に行われたQ&A検索の履歴を、REST APIおよびAlliダッシュボードを通じて参照します。
認証用のAPIキー
表示する結果の数の制限(ページネーションに使用)
すべての結果のリストで、結果のリストを開始するインデックス(ページネーションに使用)
履歴を取得したい最新の日付(YYYY-MM-DDの形式である必要があります)
履歴を取得したい最も過去の日付(YYYY-MM-DDの形式での日付)
DESC(最新のクエリが最初に表示されることを意味)または ASC(最も古いクエリが最初に表示されることを意味)のいずれかを指定できます。
クエリに表示されるべき単語
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に取得されました。
GET /webapi/faq_histories HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
正常に取得されました。
{
"result": {
"histories": [
{
"agent": {
"id": "text"
},
"question": "text",
"answers": [
{
"faq": {
"id": "text"
},
"effectiveConfidence": 1,
"confidence": 1
}
]
}
],
"count": 1
},
"errors": {}
}このAPIを使用すると、ナレッジベースの未回答の質問リストを取得できます。対象のQ&AははQ＆A登録候補（Candidates）と呼ばれます。
認証用のAPIキー
検索範囲を指定されたハッシュタグに限定したい場合は、ハッシュタグの配列を使用します。
閲覧するQ&A登録候補をフィルタリングするための検索クエリです。より高度な検索を実行するには演算子を使用できます。「TERM1 TERM2」はAND、「TERM1 OR TERM2」はOR、「TERM」は完全一致となります。
Q&A登録候補を並べ替える方法。ATTRIBUTE_[DESCまたはASC]形式を使用できます。ATTRIBUTEはFREQUENCYまたはCREATED_ATで指定することが可能です。
Q＆A登録候補のステータスを確認する。ALLまたはACTIVEまたはARCHIVEDで指定することが可能です
オフセットを指定することで、ページ上の最初のアイテムの順位番号を指定することが可能です。
limit allows you to set the number of objects returned on one page. The maximum value is 100.
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に取得しました。
GET /webapi/faq_candidates HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
正常に取得しました。
{
"result": {
"faqCandidates": [
{
"id": "text",
"frequency": 1,
"textAnswer": "text",
"state": "text",
"createdAt": 1,
"questions": [
{
"id": "text",
"question": "text",
"frequency": 1,
"history": {
"id": "text"
}
}
]
}
],
"count": 1
},
"errors": {}
}特定の日付範囲におけるFAQ検索の日ごとの件数。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。
照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。
日毎のFAQ検索件数を正常に取得しました。
GET /webapi/faq_daily_count HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"startDate": "text",
"endDate": "text"
}日毎のFAQ検索件数を正常に取得しました。
{
"result": {
"dailyTotalCount": [
{
"date": "text",
"count": 1
}
],
"state": "text",
"campaignCount": 1
},
"errors": {}
}最も頻繁に質問されるQ&Aの分析情報。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
最も頻繁に質問されるQ&Aの上位N。Nの最大値は20です。Nには1、5、10、または20を使用してください。
クエリする日付範囲の開始をYYYY-MM-DD形式で指定します。
クエリする日付範囲の終了をYYYY-MM-DD形式で指定します。
FAQアナリティクスの取得に成功しました。
GET /webapi/faq_daily_analytics HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"topN": 1,
"startDate": "text",
"endDate": "text"
}FAQアナリティクスの取得に成功しました。
{
"result": {
"faqDailyAnalytics": [
{
"totalCount": 1,
"totalShownCount": 1,
"selectedRatio": 1,
"faq": {
"id": "text",
"question": "text"
},
"stats": [
{
"date": "text",
"selectedCount": 1
}
]
}
]
},
"errors": {}
}Q&A登録候補に新たな質問を追加します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Q&A登録候補に追加したい質問リスト
候補者が正常に登録されました。
POST /webapi/add_faq_candidates HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"queries": [
"text"
]
}候補者が正常に登録されました。
{
"result": {
"candidates": [
{
"id": "text"
}
]
},
"errors": {}
}Last updated
Was this helpful?