Obtenir les sujets de conversation de l'agent

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

Renvoie les résultats de la dernière exécution de découverte de sujets pour un agent donné.

Paramètres de chemin

agent_idstringRequis

ID de l’agent

Paramètres de requête

page_sizeinteger or nullOptionnel1-100

Nombre de groupes de sujets de premier niveau à renvoyer.

sort_byenumOptionnel

Colonne selon laquelle classer les sujets. Utilisez conversations pour le volume, sentiment avec sort_direction=asc pour les sujets les plus négatifs, et frustration avec sort_direction=desc pour les plus frustrants. Les sujets sans score sont toujours classés en dernier.

Valeurs autorisées:

sort_directionenumOptionnel

Sens de tri des sujets.

Valeurs autorisées:

from_unix_secsinteger or nullOptionnel

Début de la fenêtre pour laquelle afficher les sujets. Lorsqu’il est défini avec to_unix_secs, les exécutions quotidiennes terminées de découverte de sujets comprises dans la plage sont agrégées ; la fenêtre délimite donc les métriques ainsi que l’ensemble de sujets. La valeur est arrondie au début de son jour UTC, car les exécutions couvrent des journées UTC entières ; aggregated_run_count indique le nombre d’exécutions additionnées. Omettez les deux bornes pour obtenir uniquement la dernière exécution.

to_unix_secsinteger or nullOptionnel

Fin de la période pour laquelle afficher les sujets.

include_evaluation_criteriabooleanOptionnelPar défaut true

Inclut le détail de l’évaluation par critère dans les métriques de chaque sujet. Transmettez false pour l’omettre : il représente l’essentiel de la charge utile, et le success_rate pondéré est renvoyé dans les deux cas.

cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

topicslist of objects

window_start_unix_secsinteger

window_end_unix_secsinteger

aggregated_run_countintegerOptionnelPar défaut 0

Nombre d’exécutions quotidiennes de découverte de sujets sur lesquelles les métriques renvoyées ont été cumulées.

has_morebooleanOptionnelPar défaut false

next_cursorstring or nullOptionnel

Erreurs

422

Unprocessable Entity Error

Paramètres de chemin

En-têtes

Paramètres de requête

Réponse

Erreurs