Faqs

FAQ related APIs

回答を選択

post

特定のFAQをユーザーが選択したものとして処理することができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

idstringOptional

選択したいQ&AのID

hashIdstringOptional

Q&A検索結果のID

Responses

200

選択されたQ&A

application/json

404

無効なQ&Aです

post

/webapi/faq/select_answer

HTTPcURLJavaScriptPython

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"
}

Q&Aから検索

post

このAPIを使用すると、Q&Aナレッジベースから最も関連性の高い質問と回答のペアを見つけることができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

autoRegisterCandidatesbooleanOptional

デフォルト値はtrueです。このオプションをfalseに設定すると、指定されたクエリに対して答えがない場合、自動的にQ&A登録候補にクエリが登録されません。

hashtagsOperatorstring · enumOptional

ANDまたはORのいずれかを選択します。
すべてのハッシュタグを含む結果を返したい場合はANDを選択します。
少なくとも1つのハッシュタグを含む結果を返したい場合はORを選択します。

Possible values:

hashtagsstring[]Optional

表示したいすべてのハッシュタグの配列。

maxResultsintegerOptional

返される結果の最大数。

querystringOptional

質問内容。

formatstring · enumOptional

html またはテキストの場合。テキストの場合、返り値はプレーンテキストになります。html の場合、html を返します。異なるフォントサイズや色などのスタイルがある html を使用する場合、html を使用できます。単にテキストとして答えを得たい場合は、テキストを使用できます。デフォルト値は html です。

Possible values:

Responses

200

APIは、Q&Aデータから最も関連性の高い質問と回答を見つけます。

application/json

post

/webapi/faq

HTTPcURLJavaScriptPython

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"
}

200

APIは、Q&Aデータから最も関連性の高い質問と回答を見つけます。

{
  "result": [
    {
      "confidence": 1,
      "effectiveConfidence": 1,
      "question": "text",
      "answer": "text",
      "id": "text",
      "hashtags": [
        "text"
      ],
      "lastUpdatedDate": "2025-12-17",
      "agentFeedback": {
        "positiveCount": 1,
        "negativeCount": 1
      },
      "userFeedback": {
        "positiveCount": 1,
        "negativeCount": 1
      }
    }
  ],
  "count": 1,
  "hashId": "text"
}

シングルQ&Aを取得

get

シングルQ&Aのすべての詳細を取得する方法です。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

idstringRequired

お探しのFAQのID。

formatstring · enumOptional

このFAQの回答値の形式。デフォルトはHTMLです。

Possible values:

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

FAQの詳細を正常に取得しました。

application/json

404

FAQが見つかりません

application/json

get

/webapi/single_faq

HTTPcURLJavaScriptPython

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-17",
    "createdDate": "2025-12-17",
    "hashtags": [
      "text"
    ],
    "statusOnAt": "2025-12-17T04:41:06.294Z",
    "statusOffAt": "2025-12-17T04:41:06.294Z",
    "folder": "text",
    "agentEditor": [
      "text"
    ],
    "agentViewer": [
      "text"
    ],
    "allowOtherAgentsView": true,
    "allowOtherUsersView": true
  }
}

Q&Aを一覧表示する

get

ナレッジベースのQ&Aを一覧表示できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

offsetintegerOptional

オフセットを使用すると、ページ上の最初の項目のランク番号を指定できます。

Default: 0

limitintegerOptional

1ページあたりに返されるオブジェクトの数を設定できます。最大値およびデフォルト値は1000です。

Default: 1000

formatstring · enumOptional

回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式でも可能です。

Default: htmlPossible values:

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

成功

application/json

get

/webapi/faqs

HTTPcURLJavaScriptPython

GET /webapi/faqs HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

{
  "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-17",
      "createdDate": "2025-12-17"
    }
  ]
}

Q&Aを検索する

post

ナレッジベース内のQ&Aの検索およびフィルタリングができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

searchTermstringOptional

リストを絞り込むためのキーワード検索クエリです。以下の方法で高度な検索が可能です。を使用できます。ANDの場合は"TERM1 TERM2"、ORの場合は"TERM1 OR TERM2"、完全一致の場合は"TERM"を使用します。

isUsedbooleanOptional

Trueの場合、有効になっているQ&Aのみが一覧表示されます。Falseの場合、無効になっているQ&Aのみが一覧表示されます。

hashtagsstring[]Optional

リストをフィルタリングするためのハッシュタグ。複数のハッシュタグを追加できます。

hashtagsOperatorstring · enumOptional

「AND」の場合、ハッシュタグのフィルターは複数のハッシュタグに対してANDロジックで機能します。「OR」の場合、ORロジックで機能します。

Possible values:

createdByAgentbooleanOptional

Trueの場合、リストには管理者によって作成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。createdByAgent、answeredByMrc、autoGenerated、editedByAgentの各フィルターは互いに排他的です。これらを2つ以上同時に指定した場合は、OR条件として扱われます。

answeredByMrcbooleanOptional

Trueの場合、ドキュメントから自動抽出されたQ&Aのみ、Falseの場合、その他のQ&Aのみを返します。

autoGeneratedbooleanOptional

Trueの場合、リストには自動生成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。

editedByAgentbooleanOptional

Trueの場合、リストには登録後にエージェントによって編集されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。

formatstring · enumOptional

回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式を使用できます。デフォルト値はHTMLです。

Possible values:

offsetintegerOptional

オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。

limitintegerOptional

1ページに返されるオブジェクトの数を設定します。最大値およびデフォルト値は1000です。

Responses

200

成功

application/json

post

/webapi/faqs

HTTPcURLJavaScriptPython

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
}

200

成功

{
  "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-17",
      "createdDate": "2025-12-17"
    }
  ]
}

Q&Aを追加

post

新規のQ&Aの追加や既存のQ&Aの更新ができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

questionstringOptional

Q&Aの質問部分

similarQuestionsstring[]Optional

類似質問

answerstringOptional

Q&Aの答えの部分です。同じ質問が既にナレッジベースにに存在する場合、答えが置き換えられます。

hashtagsstring[]Optional

Q&Aにハッシュタグを追加します。

statusstring · enumOptional

Q&AのON/OFFを設定します。ONにすると、登録したQ&Aが有効になります。

Possible values:

memostringOptional

Q&Aのメモ

target_folder_idstringOptional

allowOtherAgentsViewbooleanOptional

allowOtherUsersViewbooleanOptional

Responses

200

成功

application/json

post

/webapi/register_faq

HTTPcURLJavaScriptPython

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
}

200

成功

{
  "result": {
    "status": "text",
    "id": "text"
  },
  "errors": "text"
}

Q&Aの更新

put

既存のQ&Aを更新できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

idstringOptional

更新するQ&AのID

questionstringOptional

Q&Aの質問部分

similar_questionsstring[]Optional

類似質問

answerstringOptional

Q&Aの答えの部分

hashtagsstring[]Optional

Q&Aにハッシュタグを追加

statusstring · enumOptional

Q&AのON/OFFを切り替えます。ONにすると、Q&Aが有効になります。

Possible values:

target_folder_idstringOptional

allowOtherAgentsViewbooleanOptional

allowOtherUsersViewbooleanOptional

Responses

200

成功

application/json

put

/webapi/register_faq

HTTPcURLJavaScriptPython

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
}

200

成功

{
  "result": {
    "status": "text",
    "id": "text"
  },
  "errors": "text"
}

Q&Aを削除

post

このAPIを使用してQ&Aを削除できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

idstringOptional

削除したいQ&AのID。

Responses

200

FAQが正常に削除されました。

application/json

404

Q&Aデータが見つかりません

application/json

post

/webapi/delete_faq

HTTPcURLJavaScriptPython

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"
}

Q&Aをアップロードする

post

このAPIを使用することで、tsv、csv、xlsx、zip形式で複数のQ&Aをアップロードすることができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

multipart/form-data

filestring · binaryOptional

ローカルに保存されているQ&Aファイルの場所。xlsx、tsv、csv、およびzipファイルがサポートされています。

Responses

200

FAQファイルのアップロードに成功しました。

application/json

400

無効なパラメータです。

post

/webapi/upload_faq_file

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Q&Aにフィードバック

post

このAPIは、クエリによって検索されたQ&Aに対して「フィードバックを付与する / 取り消す」ためのものです。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

querystringRequired

フィードバックを付与または取り消したい Q&A に紐づいている質問文。

idstringRequired

そのQ&Aを識別するID。これはQ&A検索APIを実行した際のレスポンスから取得できます。

isPositiveboolean | nullableRequired

フィードバック内容:true → ポジティブフィードバック(肯定)、false → ネガティブフィードバック(否定)、null → フィードバックの取り消し

Responses

200

フィードバックが正常に送信されました

application/json

post

/webapi/faq_feedback

HTTPcURLJavaScriptPython

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
}

200

フィードバックが正常に送信されました

{
  "result": {
    "faqTrainSearchResult": {
      "faq": {
        "id": "text"
      },
      "agentFeedback": {
        "positiveCount": 1,
        "negativeCount": 1
      }
    }
  },
  "errors": {}
}

Q&A クエリ履歴

get

過去に行われたQ&A検索の履歴を、REST APIおよびAlliダッシュボードを通じて参照します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

limitintegerOptional

表示する結果の数の制限(ページネーションに使用)

offsetintegerOptional

すべての結果のリストで、結果のリストを開始するインデックス(ページネーションに使用)

endDatestringOptional

履歴を取得したい最新の日付(YYYY-MM-DDの形式である必要があります)

startDatestringOptional

履歴を取得したい最も過去の日付(YYYY-MM-DDの形式での日付)

orderstringOptional

DESC(最新のクエリが最初に表示されることを意味)または ASC(最も古いクエリが最初に表示されることを意味)のいずれかを指定できます。

searchTermstringOptional

クエリに表示されるべき単語

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に取得されました。

application/json

get

/webapi/faq_histories

HTTPcURLJavaScriptPython

GET /webapi/faq_histories HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得されました。

{
  "result": {
    "histories": [
      {
        "agent": {
          "id": "text"
        },
        "question": "text",
        "answers": [
          {
            "faq": {
              "id": "text"
            },
            "effectiveConfidence": 1,
            "confidence": 1
          }
        ]
      }
    ],
    "count": 1
  },
  "errors": {}
}

Q&Aの候補を取得する

get

このAPIを使用すると、ナレッジベースの未回答の質問リストを取得できます。対象のQ&AははQ＆A登録候補（Candidates）と呼ばれます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

hashtagsstring[]Optional

検索範囲を指定されたハッシュタグに限定したい場合は、ハッシュタグの配列を使用します。

searchTermstringOptional

閲覧するQ&A登録候補をフィルタリングするための検索クエリです。より高度な検索を実行するには演算子を使用できます。「TERM1 TERM2」はAND、「TERM1 OR TERM2」はOR、「TERM」は完全一致となります。

orderstringOptional

Q&A登録候補を並べ替える方法。ATTRIBUTE_[DESCまたはASC]形式を使用できます。ATTRIBUTEはFREQUENCYまたはCREATED_ATで指定することが可能です。

statestringOptional

Q＆A登録候補のステータスを確認する。ALLまたはACTIVEまたはARCHIVEDで指定することが可能です

offsetintegerOptional

オフセットを指定することで、ページ上の最初のアイテムの順位番号を指定することが可能です。

limitintegerOptional

limit allows you to set the number of objects returned on one page. The maximum value is 100.

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

正常に取得しました。

application/json

get

/webapi/faq_candidates

HTTPcURLJavaScriptPython

GET /webapi/faq_candidates HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

{
  "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件数

get

特定の日付範囲におけるFAQ検索の日ごとの件数。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

startDatestringOptional

照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。

endDatestringOptional

照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。

Responses

200

日毎のFAQ検索件数を正常に取得しました。

application/json

get

/webapi/faq_daily_count

HTTPcURLJavaScriptPython

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"
}

200

日毎のFAQ検索件数を正常に取得しました。

{
  "result": {
    "dailyTotalCount": [
      {
        "date": "text",
        "count": 1
      }
    ],
    "state": "text",
    "campaignCount": 1
  },
  "errors": {}
}

日毎のFAQ分析

get

最も頻繁に質問されるQ&Aの分析情報。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

topNintegerOptional

最も頻繁に質問されるQ&Aの上位N。Nの最大値は20です。Nには1、5、10、または20を使用してください。

startDatestringOptional

クエリする日付範囲の開始をYYYY-MM-DD形式で指定します。

endDatestringOptional

クエリする日付範囲の終了をYYYY-MM-DD形式で指定します。

Responses

200

FAQアナリティクスの取得に成功しました。

application/json

get

/webapi/faq_daily_analytics

HTTPcURLJavaScriptPython

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"
}

200

FAQアナリティクスの取得に成功しました。

{
  "result": {
    "faqDailyAnalytics": [
      {
        "totalCount": 1,
        "totalShownCount": 1,
        "selectedRatio": 1,
        "faq": {
          "id": "text",
          "question": "text"
        },
        "stats": [
          {
            "date": "text",
            "selectedCount": 1
          }
        ]
      }
    ]
  },
  "errors": {}
}

Q&A登録候補

post

Q&A登録候補に新たな質問を追加します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

queriesstring[]Required

Q&A登録候補に追加したい質問リスト

Responses

200

候補者が正常に登録されました。

application/json

post

/webapi/add_faq_candidates

HTTPcURLJavaScriptPython

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"
  ]
}

200

候補者が正常に登録されました。

{
  "result": {
    "candidates": [
      {
        "id": "text"
      }
    ]
  },
  "errors": {}
}