Conversatieonderwerpen van agent ophalen

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

Retourneert de resultaten van de meest recente topic discovery-uitvoering voor een opgegeven agent.

Path parameters

agent_idstringRequired

ID van de agent

Query parameters

page_sizeinteger or nullOptional1-100

Aantal topicgroepen op het hoogste niveau dat moet worden geretourneerd.

sort_byenumOptional

Kolom waarop onderwerpen moeten worden gerangschikt. Gebruik conversations voor volume, sentiment met sort_direction=asc voor de negatiefste onderwerpen, en frustration met sort_direction=desc voor de meest frustrerende onderwerpen. Onderwerpen zonder score worden altijd als laatste gerangschikt.

Allowed values:

sort_directionenumOptional

Sorteerrichting voor onderwerpen.

Allowed values:

from_unix_secsinteger or nullOptional

Begin van het tijdvenster waarvoor onderwerpen worden weergegeven. Wanneer dit samen met to_unix_secs is ingesteld, worden de voltooide dagelijkse uitvoeringen voor onderwerpdetectie in het bereik samengevoegd. Het venster begrenst dus zowel de statistieken als de onderwerpset. Afgerond naar het begin van de UTC-dag, omdat uitvoeringen volledige UTC-dagen omvatten; aggregated_run_count geeft aan hoeveel uitvoeringen zijn opgeteld. Laat beide grenzen weg om alleen de meest recente uitvoering op te halen.

to_unix_secsinteger or nullOptional

Einde van het tijdvenster waarvoor onderwerpen worden weergegeven.

include_evaluation_criteriabooleanOptionalDefaults to true

Neem de uitsplitsing van de evaluatie per criterium op in de statistieken van elk onderwerp. Geef false door om deze weg te laten: deze vormt het grootste deel van de payload en de gewogen success_rate wordt in beide gevallen geretourneerd.

cursorstring or nullOptional

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

topicslist of objects

window_start_unix_secsinteger

window_end_unix_secsinteger

aggregated_run_countintegerOptionalDefaults to 0

Aantal dagelijkse topic-discovery-runs waarover de geretourneerde statistieken zijn opgeteld.

has_morebooleanOptionalDefaults to false

next_cursorstring or nullOptional

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Query parameters

Response

Errors