Wyświetl rozmowy

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

Pobiera wszystkie rozmowy agentów należących do użytkownika. Można ograniczyć do konkretnego agenta.

Parametry zapytania

cursorstringOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

agent_idstringOpcjonalny

Identyfikator agenta (agent_…) lub zewnętrzny identyfikator silnika mowy (seng_), wskazujące ten sam zasób.

visited_agent_idsstringOpcjonalny

Filtruj rozmowy, w których uczestniczył dowolny z tych agentów. Maksymalnie 50 wartości.

visited_agent_branch_idsstringOpcjonalny

Filtruj rozmowy, w których uczestniczyła dowolna z tych gałęzi agenta. Maksymalnie 50 wartości.

triggered_procedure_idsstringOpcjonalny

Filtruj rozmowy, w których uruchomiono dowolną z tych procedur. Maksymalnie 50 wartości.

call_successfulenumOpcjonalny

Wynik oceny powodzenia

Dozwolone wartości:

call_start_before_unixintegerOpcjonalny

Znacznik czasu Unix (w sekundach) do filtrowania rozmów do tej daty początkowej.

call_start_after_unixintegerOpcjonalny

Znacznik czasu Unix (w sekundach) do filtrowania rozmów po tej dacie początkowej.

call_duration_min_secsintegerOpcjonalny

Minimalny czas trwania połączenia w sekundach.

call_duration_max_secsintegerOpcjonalny

Maksymalny czas trwania połączenia w sekundach.

rating_maxintegerOpcjonalny1-5

Maksymalna ocena ogólna (1–5).

rating_minintegerOpcjonalny1-5

Minimalna ocena ogólna (1–5).

has_feedback_commentbooleanOpcjonalny

Filtruj rozmowy z komentarzami użytkowników.

user_idstringOpcjonalny

Filtruj rozmowy według ID użytkownika, który je rozpoczął.

evaluation_paramsstringOpcjonalny

Filtry oceny. Parametr powtarzalny. Format: criteria_id:result, gdzie result to success|failure|unknown. Przykład: eval=value_framing:success

data_collection_paramsstringOpcjonalny

Filtry zbierania danych. Parametr powtarzalny. Format: id:op:value, gdzie op to jedno z eq|neq|gt|gte|lt|lte|in. Dla in oddziel wartości pionową kreską. Pusta wartość pasuje do rozmów, w których pole nie zostało zebrane (id:eq:), a neq z pustą wartością — do tych, w których zostało zebrane (id:neq:). eq oznacza dokładną równość. gt|gte|lt|lte wymagają wartości liczbowej.

dynamic_variable_paramsstringOpcjonalny

Filtry zmiennych dynamicznych. Parametr powtarzalny. Format: name:op:value, gdzie op to jedna z wartości eq|neq|gt|gte|lt|lte|in. Dla in rozdziel wartości pionową kreską. Pusta wartość dopasowuje rozmowy, w których zmienna nie została ustawiona (name:eq:), a neq z pustą wartością dopasowuje te, w których została ustawiona (name:neq:). eq oznacza dokładną równość. gt|gte|lt|lte wymagają wartości liczbowej. Nie można wyrazić nazw zawierających „:”.

data_collection_idsstringOpcjonalny

Identyfikatory pól zbierania danych, które mają być uwzględniane w każdym podsumowaniu rozmowy. Parametr powtarzalny. Jeśli go pominięto, data_collection_results nie jest zwracane.

evaluation_criteria_idsstringOpcjonalny

Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned.

tool_namesstringOpcjonalny

Filtruj rozmowy według nazw narzędzi użytych podczas połączenia.

tool_names_successfulstringOpcjonalny

Filtruj rozmowy według nazw narzędzi, których wywołania zakończyły się powodzeniem.

tool_names_erroredstringOpcjonalny

Filtruj rozmowy według nazw narzędzi, których wywołania zakończyły się błędem.

include_invalid_tool_callsbooleanOpcjonalnyDomyślnie false

Uwzględnia też wywołania narzędzi, które nigdy nie zostały uruchomione.

main_languagesstringOpcjonalny

Filtruj rozmowy według wykrytego głównego języka (kodu języka).

page_sizeintegerOpcjonalny1-100Domyślnie 30

Maksymalna liczba rozmów do zwrócenia. Nie może przekraczać 100, domyślnie 30.

summary_modeenumOpcjonalnyDomyślnie exclude

Czy uwzględniać podsumowania transkrypcji w odpowiedzi.

Dozwolone wartości:

searchstringOpcjonalnyDeprecated

Wyszukiwanie pełnotekstowe lub przybliżone w wiadomościach transkrypcji

conversation_initiation_sourceenumOpcjonalnyDomyślnie unknown

Wyliczenie przedstawiające możliwe źródła rozpoczęcia rozmowy.

text_onlybooleanOpcjonalny

conversation_product_typeenumOpcjonalny

Ogranicz wyniki do jednego obszaru produktu rozmów.

Dozwolone wartości:

branch_idstringOpcjonalny

Filtruj rozmowy według ID gałęzi.

version_idstringOpcjonalny

Filtruj rozmowy według ID wersji.

parent_conversation_idstringOpcjonalny

Filtruj rozmowy subagentów według ID rozmowy nadrzędnej.

topic_idsstringOpcjonalny

Filtruj rozmowy według ID tematów przypisanych podczas wykrywania tematów.

exclude_statusesenumOpcjonalny

Wyklucza rozmowy o podanych statusach. Przydatne do ukrywania rozmów w toku / przetwarzanych na listach.

Dozwolone wartości:

tag_idsstringOpcjonalny

Filtruj rozmowy według ID tagów rozmów przypisanych przez endpointy conversation-tags.

workflow_node_entered_idstringOpcjonalny

Filtruj rozmowy, aby zwrócić tylko te, które przeszły przez wskazany węzeł.

termination_reasonsstringOpcjonalny

Filtruj rozmowy według zapisanej wartości termination_reason (metadata.termination_reason). Powtórz parametr, aby dopasować dowolną z kilku wartości.

guardrail_typesenumOpcjonalny

Filtruj rozmowy, w których uruchomiono regułę zabezpieczeń dowolnego z tych typów (metadata.triggered_guardrails.guardrail_type). Powtórz parametr, aby dopasować dowolną z kilku wartości.

custom_guardrail_namesstringOpcjonalny

Filtruj rozmowy, w których uruchomiono niestandardową regułę zabezpieczeń o dowolnej z tych nazw (metadata.triggered_guardrails.guardrail_name). Nazwę mają tylko niestandardowe reguły zabezpieczeń. Powtórz parametr, aby dopasować dowolną z kilku wartości.

sort_directionenumOpcjonalny

Kierunek sortowania rozmów według czasu rozpoczęcia połączenia. Domyślnie malejąco (od najnowszych).

Dozwolone wartości:

Odpowiedź

Pomyślna odpowiedź

conversationslist of objects

has_moreboolean

next_cursorstringOpcjonalny

Błędy

422

Conversations List Request Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy