会話を一覧表示

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d call_duration_max_secs=1 \
     -d call_duration_min_secs=1 \
     -d call_start_after_unix=1 \
     -d call_start_before_unix=1 \
     -d call_successful=success \
     -d conversation_initiation_source=unknown \
     -d conversation_product_type=agents \
     -d cursor=cursor \
     -d custom_guardrail_names=custom_guardrail_names \
     -d data_collection_ids=data_collection_ids \
     -d data_collection_params=data_collection_params \
     -d dynamic_variable_params=dynamic_variable_params \
     -d evaluation_criteria_ids=evaluation_criteria_ids \
     -d evaluation_params=evaluation_params \
     -d exclude_statuses=initiated \
     -d guardrail_types=custom \
     -d has_feedback_comment=true \
     -d include_invalid_tool_calls=true \
     -d main_languages=main_languages \
     -d page_size=1 \
     -d parent_conversation_id=parent_conversation_id \
     -d rating_max=1 \
     -d rating_min=1 \
     -d search=search \
     -d sort_direction=asc \
     -d summary_mode=exclude \
     -d tag_ids=tag_ids \
     -d termination_reasons=termination_reasons \
     -d text_only=true \
     -d tool_names=tool_names \
     -d tool_names_errored=tool_names_errored \
     -d tool_names_successful=tool_names_successful \
     -d topic_ids=topic_ids \
     -d triggered_procedure_ids=triggered_procedure_ids \
     -d user_id=user_id \
     -d version_id=version_id \
     -d visited_agent_branch_ids=visited_agent_branch_ids \
     -d visited_agent_ids=visited_agent_ids \
     -d workflow_node_entered_id=workflow_node_entered_id

{
  "conversations": [
    {
      "agent_id": "agent_id",
      "conversation_id": "conversation_id",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "branch_id",
      "version_id": "version_id",
      "agent_name": "agent_name",
      "termination_reason": "termination_reason",
      "call_success_score": 1.1,
      "transcript_summary": "transcript_summary",
      "call_summary_title": "call_summary_title",
      "main_language": "main_language",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "tool_names"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 1.1,
        "overall_frustration_score": 1.1,
        "min_user_sentiment_score": 1.1,
        "max_user_frustration_score": 1.1,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {
        "key": "value"
      },
      "tag_ids": [
        "tag_ids"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

ユーザーが所有するエージェントのすべての会話を取得します。特定のエージェントに限定することもできます。

クエリパラメータ

cursorstringオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

agent_idstringオプション

同じ基盤リソースに解決されるエージェントID（agent_…）または音声エンジン外部ID（seng_）。

visited_agent_idsstringオプション

これらのエージェントのいずれかが参加した会話をフィルタリングします。指定できる値は50件までです。

visited_agent_branch_idsstringオプション

これらのエージェントブランチのいずれかが参加した会話をフィルタリングします。指定できる値は50件までです。

triggered_procedure_idsstringオプション

これらのプロシージャのいずれかがトリガーされた会話をフィルタリングします。指定できる値は50件までです。

call_successfulenumオプション

成功評価の結果

許可された値:

call_start_before_unixintegerオプション

この開始日時までの会話をフィルタリングするためのUnixタイムスタンプ（秒）。

call_start_after_unixintegerオプション

この開始日時より後の会話をフィルタリングするためのUnixタイムスタンプ（秒）。

call_duration_min_secsintegerオプション

通話の最小時間（秒）。

call_duration_max_secsintegerオプション

通話の最大時間（秒）。

rating_maxintegerオプション1-5

総合評価の最大値（1～5）。

rating_minintegerオプション1-5

総合評価の最小値（1～5）。

has_feedback_commentbooleanオプション

ユーザーフィードバックコメントがある会話をフィルタリングします。

user_idstringオプション

開始したユーザーのIDで会話をフィルタリングします。

evaluation_paramsstringオプション

評価フィルターです。繰り返し指定できるパラメータです。形式：criteria_id:result。resultにはsuccess|failure|unknownのいずれかを指定します。例：eval=value_framing:success

data_collection_paramsstringオプション

データ収集フィルター。繰り返し指定できるパラメータです。形式：id:op:value。opにはeq|neq|gt|gte|lt|lte|inのいずれかを指定します。inでは値をパイプで区切ります。空の値はフィールドが収集されなかった会話に一致します（id:eq:）。空の値を指定したneqは、フィールドが収集された会話に一致します（id:neq:）。eqは完全一致です。gt|gte|lt|lteには数値が必要です。

dynamic_variable_paramsstringオプション

動的変数フィルター。繰り返し指定できるパラメータです。形式：name:op:value。opにはeq|neq|gt|gte|lt|lte|inのいずれかを指定します。inでは値をパイプで区切ります。値を空にすると、変数が設定されていない会話に一致します（name:eq:）。空の値を伴うneqは、変数が設定されている会話に一致します（name:neq:）。eqは完全一致です。gt|gte|lt|lteには数値が必要です。’:‘を含む名前は指定できません。

data_collection_idsstringオプション

各会話サマリーに含めるデータ収集フィールドID。繰り返し指定できるパラメータです。省略した場合、data_collection_resultsは返されません。

evaluation_criteria_idsstringオプション

各会話の概要に含める評価基準IDです。繰り返し指定できるパラメータです。省略した場合、evaluation_criteria_resultsは返されません。

tool_namesstringオプション

通話中に使用されたツール名で会話をフィルタリングします。

tool_names_successfulstringオプション

成功した呼び出しがあるツール名で会話をフィルタリングします。

tool_names_erroredstringオプション

エラーになった呼び出しがあるツール名で会話をフィルタリングします。

include_invalid_tool_callsbooleanオプションデフォルト値 false

実行されなかったツール呼び出しも一致対象にします。

main_languagesstringオプション

検出された主要言語（言語コード）で会話をフィルタリングします。

page_sizeintegerオプション1-100デフォルト値 30

返す会話の最大数です。100を超えることはできず、デフォルトは30です。

summary_modeenumオプションデフォルト値 exclude

レスポンスに文字起こしの要約を含めるかどうか。

許可された値:

searchstringオプションDeprecated

文字起こしメッセージに対する全文検索またはあいまい検索

conversation_initiation_sourceenumオプションデフォルト値 unknown

会話開始に使用できるソースを表す列挙型です。

text_onlybooleanオプション

conversation_product_typeenumオプション

結果を単一の会話プロダクト画面に限定します。

許可された値:

branch_idstringオプション

ブランチIDで会話をフィルタリングします。

version_idstringオプション

バージョンIDで会話をフィルタリングします。

parent_conversation_idstringオプション

サブエージェント会話の親会話IDで会話をフィルタリングします。

topic_idsstringオプション

トピック検出中に割り当てられたトピックIDで会話をフィルタリングします。

exclude_statusesenumオプション

指定したステータスの会話を除外します。進行中／処理中の会話をリストビューで非表示にする場合に便利です。

許可された値:

tag_idsstringオプション

conversation-tagsエンドポイントで割り当てられた会話タグIDで会話をフィルタリングします。

workflow_node_entered_idstringオプション

指定されたノードに入った会話のみにフィルタリングします。

termination_reasonsstringオプション

保存されているtermination_reason（metadata.termination_reason）で会話をフィルタリングします。複数のいずれかに一致させるには、パラメータを繰り返してください。

guardrail_typesenumオプション

これらのタイプのガードレールのいずれかがトリガーされた会話（metadata.triggered_guardrails.guardrail_type）にフィルタリングします。複数のいずれかに一致させるには、パラメータを繰り返してください。

custom_guardrail_namesstringオプション

これらの名前を持つカスタムガードレールのいずれかがトリガーされた会話（metadata.triggered_guardrails.guardrail_name）にフィルタリングします。名前を持つのはカスタムガードレールのみです。複数のいずれかに一致させるには、パラメータを繰り返してください。

sort_directionenumオプション

通話開始時刻で会話を並べ替える方向。デフォルトは降順（新しい順）です。

許可された値:

レスポンス

成功レスポンス。

conversationslist of objects

has_moreboolean

next_cursorstringオプション

エラー

422

Conversations List Request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー