Gespreksberichten met tekst zoeken

GET

/v1/convai/conversations/messages/text-search

GET

/v1/convai/conversations/messages/text-search

curl -G https://api.elevenlabs.io/v1/convai/conversations/messages/text-search \
     -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 data_collection_params=data_collection_params \
     -d dynamic_variable_params=dynamic_variable_params \
     -d evaluation_params=evaluation_params \
     -d exclude_statuses=initiated \
     -d has_feedback_comment=true \
     -d include_invalid_tool_calls=true \
     -d main_languages=main_languages \
     -d page_size=1 \
     -d rating_max=1 \
     -d rating_min=1 \
     -d sort_by=search_score \
     -d summary_mode=exclude \
     -d termination_reasons=termination_reasons \
     -d text_only=true \
     --data-urlencode "text_query=refund policy" \
     -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

{
  "results": [
    {
      "conversation_id": "conversation_id",
      "agent_id": "agent_id",
      "transcript_index": 1,
      "chunk_text": "chunk_text",
      "score": 1.1,
      "conversation_start_time_unix_secs": 1,
      "agent_name": "agent_name",
      "chunk_highlights": [
        {
          "value": "value",
          "is_hit": true
        }
      ]
    }
  ],
  "has_more": true,
  "meta": {
    "total": 1,
    "page": 1,
    "page_size": 1
  },
  "next_cursor": "next_cursor"
}

Doorzoek berichten in gesprekstranscripten met full-text- en fuzzy search

Queryparameters

text_querystringVerplicht

De tekst van de zoekopdracht voor volledige tekst en fuzzy matching

agent_idstringOptioneel

Agent-ID (agent_…) of externe ID van de spraakengine (seng_), die naar dezelfde onderliggende resource verwijzen.

visited_agent_idsstringOptioneel

Filter gesprekken waaraan een van deze agents heeft deelgenomen. Maximaal 50 waarden.

visited_agent_branch_idsstringOptioneel

Filter gesprekken waaraan een van deze agentbranches heeft deelgenomen. Maximaal 50 waarden.

triggered_procedure_idsstringOptioneel

Filter gesprekken waarin een van deze procedures is geactiveerd. Maximaal 50 waarden.

call_successfulenumOptioneel

Het resultaat van de succesevaluatie

Toegestane waarden:

call_start_before_unixintegerOptioneel

Unix-timestamp (in seconden) om gesprekken tot deze startdatum te filteren.

call_start_after_unixintegerOptioneel

Unix-timestamp (in seconden) om gesprekken vanaf deze startdatum te filteren.

call_duration_min_secsintegerOptioneel

Minimale gespreksduur in seconden.

call_duration_max_secsintegerOptioneel

Maximale gespreksduur in seconden.

rating_maxintegerOptioneel1-5

Maximale algemene beoordeling (1-5).

rating_minintegerOptioneel1-5

Minimale algemene beoordeling (1-5).

has_feedback_commentbooleanOptioneel

Filter gesprekken met feedbackreacties van gebruikers.

user_idstringOptioneel

Filter gesprekken op de gebruikers-ID van degene die ze heeft gestart.

evaluation_paramsstringOptioneel

Evaluatiefilters. Herhaalbare parameter. Indeling: criteria_id:result, waarbij result een van success|failure|unknown is. Voorbeeld: eval=value_framing:success

data_collection_paramsstringOptioneel

Filters voor gegevensverzameling. Herhaalparameter. Indeling: id:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Gebruik voor in een pipe als scheidingsteken tussen waarden. Een lege waarde komt overeen met gesprekken waarin het veld niet is verzameld (id:eq:), en neq met een lege waarde komt overeen met gesprekken waarin dat wel het geval was (id:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde.

dynamic_variable_paramsstringOptioneel

Filters voor dynamische variabelen. Herhaalbare parameter. Indeling: name:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Scheid waarden voor in met een verticale streep. Een lege waarde komt overeen met gesprekken waarin de variabele niet was ingesteld (name:eq:), en neq met een lege waarde komt overeen met gesprekken waarin deze wel was ingesteld (name:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde. Namen die ’:’ bevatten, kunnen niet worden uitgedrukt.

tool_namesstringOptioneel

Filter gesprekken op toolnamen die tijdens de call zijn gebruikt.

tool_names_successfulstringOptioneel

Filter gesprekken op toolnamen met geslaagde calls.

tool_names_erroredstringOptioneel

Filter gesprekken op toolnamen met mislukte calls.

include_invalid_tool_callsbooleanOptioneelStandaard false

Komt ook overeen met toolaanroepen die nooit zijn uitgevoerd.

main_languagesstringOptioneel

Filter gesprekken op gedetecteerde hoofdtaal (taalcode).

exclude_statusesenumOptioneel

Sluit gesprekken met de opgegeven statussen uit. Handig om gesprekken die nog bezig zijn / worden verwerkt te verbergen in lijstweergaven.

Toegestane waarden:

termination_reasonsstringOptioneel

Filter gesprekken op hun opgeslagen termination_reason (metadata.termination_reason). Herhaal de parameter om een van meerdere waarden te matchen.

page_sizeintegerOptioneel1-50Standaard 20

Aantal resultaten per pagina. Maximaal 50.

summary_modeenumOptioneelStandaard exclude

Of transcript-samenvattingen in de response moeten worden opgenomen.

Toegestane waarden:

conversation_initiation_sourceenumOptioneelStandaard unknown

Enum die de mogelijke bronnen voor het starten van een gesprek weergeeft.

text_onlybooleanOptioneel

conversation_product_typeenumOptioneel

Beperk de resultaten tot één productinterface voor gesprekken.

Toegestane waarden:

branch_idstringOptioneel

Filter gesprekken op branch-ID.

version_idstringOptioneel

Filter gesprekken op versie-ID.

topic_idsstringOptioneel

Filter gesprekken op topic-ID’s die tijdens topic discovery zijn toegewezen.

sort_byenumOptioneel

Sorteervolgorde voor zoekresultaten. ‘search_score’ sorteert op zoekscore, ‘created_at’ sorteert op de starttijd van het gesprek.

Toegestane waarden:

cursorstringOptioneel

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

Response

Geslaagde response

resultslist of objects

has_moreboolean

Of er meer resultaten beschikbaar zijn

metaobjectOptioneel

next_cursorstringOptioneel

Cursor voor de volgende pagina met resultaten

Fouten

422

Messages Text Search Request Unprocessable Entity Error

Headers

Queryparameters

Response

Fouten