Smart search

GET

/v1/convai/conversations/messages/smart-search

GET

/v1/convai/conversations/messages/smart-search

curl -G https://api.elevenlabs.io/v1/convai/conversations/messages/smart-search \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d cursor=cursor \
     -d page_size=1 \
     --data-urlencode "text_query=Customer asking to cancel and get money back"

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

Search conversation transcripts by semantic similarity to surface relevant messages based on meaning and intent, rather than exact keyword matches

Paramètres de requête

text_querystringRequis

The search query text for semantic similarity matching

agent_idstringOptionnel

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

branch_idstringOptionnel

Filter conversations by branch ID.

page_sizeintegerOptionnel1-50Par défaut 20

Number of results per page. Max 50.

cursorstringOptionnel

Used for fetching next page. Cursor is returned in the response.

Réponse

Successful Response

resultslist of objects

has_moreboolean

Whether there are more results available

metaobjectOptionnel

next_cursorstringOptionnel

Cursor for the next page of results

Erreurs

422

Messages Search Request Unprocessable Entity Error

En-têtes

Paramètres de requête

Réponse

Erreurs