Naar navigatie springen

Conversatieonderwerpen van agent ophalen

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

Padparameters

agent_idstringVerplicht
ID van de agent

Headers

xi-api-keystringOptioneel

Queryparameters

page_sizeintegerOptioneel1-100
Aantal topicgroepen op het hoogste niveau dat moet worden geretourneerd.
sort_byenumOptioneel

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.

Toegestane waarden:
sort_directionenumOptioneel
Sorteerrichting voor onderwerpen.
Toegestane waarden:
from_unix_secsintegerOptioneel

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_secsintegerOptioneel
Einde van het tijdvenster waarvoor onderwerpen worden weergegeven.
include_evaluation_criteriabooleanOptioneelStandaard 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.

cursorstringOptioneel
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_countintegerOptioneelStandaard 0

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

has_morebooleanOptioneelStandaard false
next_cursorstringOptioneel

Fouten

422
Topics Get Request Unprocessable Entity Error