Recupera argomenti di conversazione dell'agente

GET

/v1/convai/agents/:agent_id/topics

GET

/v1/convai/agents/:agent_id/topics

curl https://api.elevenlabs.io/v1/convai/agents/agent_id/topics

{
  "topics": [
    {
      "topic_id": "string",
      "label": "string",
      "description": "string",
      "conversation_count": 1,
      "parent_topic_id": "string",
      "x_2d": 1.1,
      "y_2d": 1.1,
      "metrics": {
        "conversation_count": 0,
        "sentiment": {
          "sentiment": {
            "count": 0,
            "sum": 0,
            "min": 1.1,
            "max": 1.1
          },
          "frustration": {
            "count": 0,
            "sum": 0,
            "min": 1.1,
            "max": 1.1
          },
          "positive_count": 0,
          "neutral_count": 0,
          "negative_count": 0
        },
        "evaluation_criteria": [
          {
            "criteria_id": "string",
            "success_count": 0,
            "failure_count": 0,
            "unknown_count": 0
          }
        ]
      },
      "success_rate": 1.1
    }
  ],
  "window_start_unix_secs": 1,
  "window_end_unix_secs": 1,
  "aggregated_run_count": 0,
  "has_more": false,
  "next_cursor": "string"
}

Restituisce gli ultimi risultati dell'esecuzione di individuazione degli argomenti per un determinato agente.

Parametri di percorso

agent_idstringObbligatorio

ID dell'agente

Parametri di query

page_sizeinteger or nullOpzionale1-100

Numero di gruppi di argomenti di primo livello da restituire.

sort_byenumOpzionale

Colonna in base alla quale classificare gli argomenti. Usa conversations per il volume, sentiment con sort_direction=asc per gli argomenti più negativi e frustration con sort_direction=desc per quelli più frustranti. Gli argomenti senza punteggio vengono sempre classificati per ultimi.

Valori consentiti:

sort_directionenumOpzionale

Direzione di ordinamento degli argomenti.

Valori consentiti:

from_unix_secsinteger or nullOpzionale

Inizio della finestra per visualizzare gli argomenti. Se impostato con to_unix_secs, le esecuzioni giornaliere completate di rilevamento degli argomenti nell'intervallo vengono aggregate; la finestra delimita quindi sia le metriche sia l'insieme di argomenti. Viene arrotondato per difetto all'inizio del relativo giorno UTC, poiché le esecuzioni coprono intere giornate UTC; aggregated_run_count indica quante esecuzioni sono state sommate. Ometti entrambi i limiti per ottenere l'unica esecuzione più recente.

to_unix_secsinteger or nullOpzionale

Fine della finestra temporale per la visualizzazione degli argomenti.

include_evaluation_criteriabooleanOpzionalePredefinito a true

Include la ripartizione della valutazione per criterio nelle metriche di ogni argomento. Passa false per ometterla: rappresenta la maggior parte del payload e il valore ponderato di success_rate viene restituito in entrambi i casi.

cursorstring or nullOpzionale

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

Risposta

Risposta riuscita

topicslist of objects

window_start_unix_secsinteger

window_end_unix_secsinteger

aggregated_run_countintegerOpzionalePredefinito a 0

Numero di esecuzioni giornaliere di rilevamento degli argomenti su cui sono state sommate le metriche restituite.

has_morebooleanOpzionalePredefinito a false

next_cursorstring or nullOpzionale

Errori

422

Unprocessable Entity Error

Parametri di percorso

Header

Parametri di query

Risposta

Errori