Buscar mensajes de conversación por texto

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

Busca en los mensajes de las transcripciones de conversaciones mediante búsqueda de texto completo y aproximada.

Parámetros de consulta

text_querystringRequerido

El texto de la consulta de búsqueda para coincidencias de texto completo y aproximadas

agent_idstringOpcional

ID del agente (agent_…) o ID externo del motor de voz (seng_), que se resuelven en el mismo recurso subyacente.

visited_agent_idsstringOpcional

Filtra conversaciones en las que participó alguno de estos agentes. No puede superar los 50 valores.

visited_agent_branch_idsstringOpcional

Filtra conversaciones en las que participó alguna de estas ramas del agente. No puede superar los 50 valores.

triggered_procedure_idsstringOpcional

Filtra conversaciones en las que se activó alguno de estos procedimientos. No puede superar los 50 valores.

call_successfulenumOpcional

El resultado de la evaluación de éxito

Valores permitidos:

call_start_before_unixintegerOpcional

Marca de tiempo Unix (en segundos) para filtrar conversaciones hasta esta fecha de inicio.

call_start_after_unixintegerOpcional

Marca de tiempo Unix (en segundos) para filtrar conversaciones posteriores a esta fecha de inicio.

call_duration_min_secsintegerOpcional

Duración mínima de la llamada en segundos.

call_duration_max_secsintegerOpcional

Duración máxima de la llamada en segundos.

rating_maxintegerOpcional1-5

Valoración global máxima (1-5).

rating_minintegerOpcional1-5

Valoración global mínima (1-5).

has_feedback_commentbooleanOpcional

Filtra conversaciones con comentarios de usuarios.

user_idstringOpcional

Filtra conversaciones por el ID del usuario que las inició.

evaluation_paramsstringOpcional

Filtros de evaluación. Parámetro repetible. Formato: criteria_id:result, donde result es uno de success|failure|unknown. Ejemplo: eval=value_framing:success

data_collection_paramsstringOpcional

Filtros de recopilación de datos. Parámetro repetible. Formato: id:op:value, donde op es uno de eq|neq|gt|gte|lt|lte|in. Para in, delimita los valores con barras verticales. Un valor vacío coincide con conversaciones en las que no se recopiló el campo (id:eq:), y neq con un valor vacío coincide con aquellas en las que sí se recopiló (id:neq:). eq indica igualdad exacta. gt|gte|lt|lte requieren un valor numérico.

dynamic_variable_paramsstringOpcional

Filtros de variables dinámicas. Parámetro repetible. Formato: name:op:value, donde op es uno de eq|neq|gt|gte|lt|lte|in. Para in, delimita los valores con barras verticales. Un valor vacío coincide con conversaciones en las que no se estableció la variable (name:eq:), y neq con un valor vacío coincide con aquellas en las que sí se estableció (name:neq:). eq es igualdad exacta. gt|gte|lt|lte requieren un valor numérico. No se pueden expresar nombres que contengan ’:’.

tool_namesstringOpcional

Filtra conversaciones por nombres de herramientas utilizados durante la llamada.

tool_names_successfulstringOpcional

Filtra conversaciones por nombres de herramientas cuyas llamadas se realizaron correctamente.

tool_names_erroredstringOpcional

Filtra conversaciones por nombres de herramientas cuyas llamadas dieron error.

include_invalid_tool_callsbooleanOpcionalValor predeterminado: false

Incluye también las llamadas a herramientas que nunca se ejecutaron.

main_languagesstringOpcional

Filtra conversaciones por idioma principal detectado (código de idioma).

exclude_statusesenumOpcional

Excluye las conversaciones con los estados indicados. Resulta útil para ocultar de las vistas de lista las conversaciones en curso o en procesamiento.

Valores permitidos:

termination_reasonsstringOpcional

Filtra conversaciones por su termination_reason almacenado (metadata.termination_reason). Repite el parámetro para que coincida con cualquiera de varios valores.

page_sizeintegerOpcional1-50Valor predeterminado: 20

Número de resultados por página. Máximo: 50.

summary_modeenumOpcionalValor predeterminado: exclude

Indica si se deben incluir resúmenes de las transcripciones en la respuesta.

Valores permitidos:

conversation_initiation_sourceenumOpcionalValor predeterminado: unknown

Enumeración que representa los posibles orígenes para iniciar una conversación.

text_onlybooleanOpcional

conversation_product_typeenumOpcional

Restringe los resultados a una sola interfaz de producto de conversaciones.

Valores permitidos:

branch_idstringOpcional

Filtra conversaciones por ID de rama.

version_idstringOpcional

Filtra conversaciones por ID de versión.

topic_idsstringOpcional

Filtra conversaciones por IDs de temas asignados durante el descubrimiento de temas.

sort_byenumOpcional

Orden de los resultados de búsqueda. ‘search_score’ ordena por puntuación de búsqueda y ‘created_at’ por hora de inicio de la conversación.

Valores permitidos:

cursorstringOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.

resultslist of objects

has_moreboolean

Indica si hay más resultados disponibles

metaobjectOpcional

next_cursorstringOpcional

Cursor para la siguiente página de resultados

Errores

422

Messages Text Search Request Unprocessable Entity Error

Encabezados

Parámetros de consulta

Respuesta

Errores