Elenca conversazioni

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

Ottieni tutte le conversazioni degli agenti di proprietà dell’utente, con la possibilità di limitarle a un agente specifico.

Parametri di query

cursorstringOpzionale

Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

agent_idstringOpzionale

ID dell'agente (agent_…) o ID esterno del motore vocale (seng_), risolti nella stessa risorsa sottostante.

visited_agent_idsstringOpzionale

Filtra le conversazioni a cui ha partecipato uno qualsiasi di questi agenti. Non può superare 50 valori.

visited_agent_branch_idsstringOpzionale

Filtra le conversazioni a cui ha partecipato uno qualsiasi di questi branch dell'agente. Non può superare 50 valori.

triggered_procedure_idsstringOpzionale

Filtra le conversazioni in cui è stata attivata una qualsiasi di queste procedure. Non può superare 50 valori.

call_successfulenumOpzionale

Il risultato della valutazione di successo

Valori consentiti:

call_start_before_unixintegerOpzionale

Timestamp Unix, in secondi, per filtrare le conversazioni fino a questa data di inizio.

call_start_after_unixintegerOpzionale

Timestamp Unix, in secondi, per filtrare le conversazioni successive a questa data di inizio.

call_duration_min_secsintegerOpzionale

Durata minima della chiamata in secondi.

call_duration_max_secsintegerOpzionale

Durata massima della chiamata in secondi.

rating_maxintegerOpzionale1-5

Valutazione complessiva massima (1-5).

rating_minintegerOpzionale1-5

Valutazione complessiva minima (1-5).

has_feedback_commentbooleanOpzionale

Filtra le conversazioni con commenti di feedback degli utenti.

user_idstringOpzionale

Filtra le conversazioni in base all'ID dell'utente che le ha avviate.

evaluation_paramsstringOpzionale

Filtri di valutazione. Parametro ripetibile. Formato: criteria_id:result, dove result è uno tra success|failure|unknown. Esempio: eval=value_framing:success

data_collection_paramsstringOpzionale

Filtri di raccolta dati. Parametro ripetibile. Formato: id:op:value, dove op è uno tra eq|neq|gt|gte|lt|lte|in. Per in, separa i valori con una barra verticale. Un valore vuoto corrisponde alle conversazioni in cui il campo non è stato raccolto (id:eq:), mentre neq con un valore vuoto corrisponde a quelle in cui è stato raccolto (id:neq:). eq indica un'uguaglianza esatta. gt|gte|lt|lte richiedono un valore numerico.

dynamic_variable_paramsstringOpzionale

Filtri per variabili dinamiche. Parametro ripetibile. Formato: name:op:value, dove op è uno tra eq|neq|gt|gte|lt|lte|in. Per in, delimita i valori con una barra verticale. Un valore vuoto corrisponde alle conversazioni in cui la variabile non è stata impostata (name:eq:), mentre neq con un valore vuoto corrisponde a quelle in cui è stata impostata (name:neq:). eq indica l'uguaglianza esatta. gt|gte|lt|lte richiedono un valore numerico. Non è possibile esprimere nomi contenenti ':'.

data_collection_idsstringOpzionale

ID dei campi di raccolta dati da includere in ogni riepilogo della conversazione. Parametro ripetibile. Se omesso, data_collection_results non viene restituito.

evaluation_criteria_idsstringOpzionale

ID dei criteri di valutazione da includere in ogni riepilogo della conversazione. Parametro ripetibile. Se omesso, evaluation_criteria_results non viene restituito.

tool_namesstringOpzionale

Filtra le conversazioni in base ai nomi degli strumenti usati durante la chiamata.

tool_names_successfulstringOpzionale

Filtra le conversazioni in base ai nomi degli strumenti con chiamate riuscite.

tool_names_erroredstringOpzionale

Filtra le conversazioni in base ai nomi degli strumenti con chiamate che hanno generato errori.

include_invalid_tool_callsbooleanOpzionalePredefinito a false

Trova anche le chiamate degli strumenti che non sono mai state eseguite.

main_languagesstringOpzionale

Filtra le conversazioni in base alla lingua principale rilevata (codice lingua).

page_sizeintegerOpzionale1-100Predefinito a 30

Numero massimo di conversazioni da restituire. Non può superare 100; il valore predefinito è 30.

summary_modeenumOpzionalePredefinito a exclude

Indica se includere nella risposta i riepiloghi delle trascrizioni.

Valori consentiti:

searchstringOpzionaleDeprecated

Ricerca full-text o fuzzy nei messaggi della trascrizione

conversation_initiation_sourceenumOpzionalePredefinito a unknown

Enum che rappresenta le possibili origini per l'avvio della conversazione.

text_onlybooleanOpzionale

conversation_product_typeenumOpzionale

Limita i risultati a una singola interfaccia di prodotto per conversazioni.

Valori consentiti:

branch_idstringOpzionale

Filtra le conversazioni in base all'ID del branch.

version_idstringOpzionale

Filtra le conversazioni in base all'ID della versione.

parent_conversation_idstringOpzionale

Filtra le conversazioni in base all'ID della conversazione padre per le conversazioni dei subagenti.

topic_idsstringOpzionale

Filtra le conversazioni in base agli ID degli argomenti assegnati durante il rilevamento degli argomenti.

exclude_statusesenumOpzionale

Escludi le conversazioni con gli stati indicati. Utile per nascondere dalle visualizzazioni elenco le conversazioni in corso / in elaborazione.

Valori consentiti:

tag_idsstringOpzionale

Filtra le conversazioni in base agli ID dei tag di conversazione assegnati tramite gli endpoint conversation-tags.

workflow_node_entered_idstringOpzionale

Filtra le conversazioni includendo quelle che sono entrate nel nodo specificato.

termination_reasonsstringOpzionale

Filtra le conversazioni in base al relativo termination_reason memorizzato (metadata.termination_reason). Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

guardrail_typesenumOpzionale

Filtra le conversazioni in cui è stato attivato un guardrail di uno qualsiasi di questi tipi (metadata.triggered_guardrails.guardrail_type). Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

custom_guardrail_namesstringOpzionale

Filtra le conversazioni in cui è stato attivato un guardrail personalizzato con uno qualsiasi di questi nomi (metadata.triggered_guardrails.guardrail_name). Solo i guardrail personalizzati hanno un nome. Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

sort_directionenumOpzionale

La direzione per ordinare le conversazioni in base all'ora di inizio della chiamata. Per impostazione predefinita è decrescente (prima le più recenti).

Valori consentiti:

Risposta

Risposta riuscita

conversationslist of objects

has_moreboolean

next_cursorstringOpzionale

Errori

422

Conversations List Request Unprocessable Entity Error

Header

Parametri di query

Risposta

Errori