Text search

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

Search through conversation transcript messages by full-text and fuzzy search

Parâmetros de consulta

text_querystringObrigatório

The search query text for full-text and fuzzy matching

agent_idstringOpcional

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

visited_agent_idsstringOpcional

Filter conversations where any of these agents participated. Can not exceed 50 values.

visited_agent_branch_idsstringOpcional

Filter conversations where any of these agent branches participated. Can not exceed 50 values.

triggered_procedure_idsstringOpcional

Filter conversations where any of these procedures were triggered. Can not exceed 50 values.

call_successfulenumOpcional

The result of the success evaluation

Valores permitidos:

call_start_before_unixintegerOpcional

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixintegerOpcional

Unix timestamp (in seconds) to filter conversations after to this start date.

call_duration_min_secsintegerOpcional

Minimum call duration in seconds.

call_duration_max_secsintegerOpcional

Maximum call duration in seconds.

rating_maxintegerOpcional1-5

Maximum overall rating (1-5).

rating_minintegerOpcional1-5

Minimum overall rating (1-5).

has_feedback_commentbooleanOpcional

Filter conversations with user feedback comments.

user_idstringOpcional

Filter conversations by the user ID who initiated them.

evaluation_paramsstringOpcional

Evaluation filters. Repeat param. Format: criteria_id:result where result is one of success|failure|unknown. Example: eval=value_framing:success

data_collection_paramsstringOpcional

Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the field was not collected (id:eq:), and neq with an empty value matches where it was (id:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value.

dynamic_variable_paramsstringOpcional

Dynamic variable filters. Repeat param. Format: name:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the variable was not set (name:eq:), and neq with an empty value matches where it was (name:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value. Names containing ’:’ cannot be expressed.

tool_namesstringOpcional

Filter conversations by tool names used during the call.

tool_names_successfulstringOpcional

Filter conversations by tool names that had successful calls.

tool_names_erroredstringOpcional

Filter conversations by tool names that had errored calls.

include_invalid_tool_callsbooleanOpcionalPadrão é false

Also match tool calls that never ran.

main_languagesstringOpcional

Filter conversations by detected main language (language code).

exclude_statusesenumOpcional

Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.

Valores permitidos:

termination_reasonsstringOpcional

Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.

page_sizeintegerOpcional1-50Padrão é 20

Number of results per page. Max 50.

summary_modeenumOpcionalPadrão é exclude

Whether to include transcript summaries in the response.

Valores permitidos:

conversation_initiation_sourceenumOpcionalPadrão é unknown

Enum representing the possible sources for conversation initiation.

text_onlybooleanOpcional

conversation_product_typeenumOpcional

Restrict results to a single conversation product surface.

Valores permitidos:

branch_idstringOpcional

Filter conversations by branch ID.

version_idstringOpcional

Filter conversations by version ID.

topic_idsstringOpcional

Filter conversations by topic IDs assigned during topic discovery.

sort_byenumOpcional

Sort order for search results. ‘search_score’ sorts by search score, ‘created_at’ sorts by conversation start time.

Valores permitidos:

cursorstringOpcional

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

Resposta

Successful Response

resultslist of objects

has_moreboolean

Whether there are more results available

metaobjectOpcional

next_cursorstringOpcional

Cursor for the next page of results

Erros

422

Messages Text Search Request Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros