대화 목록

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에는 숫자 값이 필요합니다. ’:‘를 포함하는 이름은 표현할 수 없습니다.

동적 변수 필터입니다. 반복 매개변수입니다. 형식: 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

헤더

쿼리 매개변수

응답

오류