シナリオ対話ログ取得API

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

シナリオ対話ログの取得を行うAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/logs
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/logs?botId={botId}&start={start}&end={end}&offset={offset}&limit={limit}&mode={mode}

リクエスト

Method POST
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type application/json;charset=UTF-8
Body JSON形式。(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード

成功

  • 200(OK)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 429(Too many requests)
Body JSON形式。(詳細はレスポンスパラメータを参照)

URLパラメータ

パラメータ名 説明
projectId シナリオ対話ログを取得する対象のプロジェクトIDを設定します。
botId シナリオ対話ログを取得する対象のボットIDを設定します。
省略した場合は全ボットが対象となります。
start 検索期間の開始日時を設定します。
startを設定してendを設定しない場合はstart以降の期間を対象に取得します。

フォーマット:YYYY-MM-DD hh:mm:ss
ミリ秒部分は自動で000が設定されます。

end 検索期間の終了日時を設定します。
endを設定してstartを設定しない場合はend以前の期間を対象に取得します。
startendともに省略した場合は全期間が対象となります。

フォーマット:YYYY-MM-DD hh:mm:ss
ミリ秒部分は自動で999が設定されます。

offset 取得開始インデックスを設定します。
省略した場合は0が設定されます。
limit 取得最大件数を設定します。
省略した場合の最大件数はサーバ側の設定値となります。
設定した最大件数がサーバ側の設定値を超えている場合、最大件数はサーバ側の設定値となります。

設定例
件数が12345件で5000件ずつ取得する場合は次のように3回リクエストを送信してください。

  1. offset=0&limit=5000
  2. offset=5000&limit=5000
  3. offset=10000&limit=5000
mode 取得するログ項目を以下から設定します。

  • min
  • all

省略した場合はminが設定されます。
minを設定した場合はstartTopicendTopicを除いた項目が取得されます。
allを設定した場合はレスポンスパラメータに記載してある項目全てが取得されます。

リクエストパラメータ

リクエストパラメータには最大10件まで詳細条件を設定できます。詳細条件は未指定も可能です。

キー
必須 説明
details object
配列
詳細条件を配列で設定します。
  operation string 検索の組み合わせ条件を設定します。
一件目の詳細条件には空文字かNOTを設定します。
その他の詳細条件は以下から設定します。

  • AND
  • OR
  • NOT
  target string 検索条件に設定するログ項目を設定します。

使用可能項目

  • userId
  • language
  • input
  • output
  • startTopic
  • endTopic
  • projectSpecific
  • responseTime_less_than
  • responseTime_greater_than
  query string 検索条件に設定するキーワードを最大200文字で設定します。
targetが以下の場合、*と文字列を組み合わせて曖昧検索が可能です。
*のみ設定した場合はログを取得できません。)

曖昧検索可能なtarget

  • userId
  • language
  • input
  • output
  • startTopic
  • endTopic
  • projectSpecific

曖昧検索例

リクエスト例

レスポンスパラメータ

シナリオ対話ログの情報は下表のソートキーで昇順ソートされた状態で出力されます。

キー
必須 説明
logs object
配列
システム対話ログの情報が配列で設定されます。
  botId string 第1ソートキー ボットIDが設定されます。
  userId string シナリオ対話APIで指定したアプリIDが設定されます。
  language string ボットの言語が設定されます。
  input string ユーザ発話が設定されます。
  output string システム発話が設定されます。
  startTopic string シナリオ対話APIで指定したinitTopicIdが設定されます。
URLパラメータのmodeallを設定した場合に設定されます。
  endTopic string 対話終了時のボットに設定されているtopicが設定されます。
URLパラメータのmodeallを設定した場合に設定されます。
  responseTime integer リクエストされてからレスポンスするまでの時間(ミリ秒)が設定されます。
  requestDateTime string 第2ソートキー リクエスト日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss.SSS

レスポンス例(正常)

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  パラメータ不正
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
429(Too many requests)
  ロックアウト なし