Listas y elementos

Una lista agrupa los elementos sobre los que se busca en conjunto. Mantén una lista por caso de uso (una para productos, otra para artículos de ayuda, otra para FAQs…): las búsquedas nunca mezclan listas.

• Nombre. Cómo identificáis la lista tú y la API. La API busca por nombre de lista, así que elige uno estable y único.

• Descripción. De qué trata la lista. Se pasa al entrenamiento como contexto, así que una descripción precisa mejora los resultados semánticos.

• Visibilidad. Las listas públicas se pueden consultar con una clave API. Las privadas solo se pueden buscar desde esta consola.

Un elemento es una entrada buscable. Tiene tres campos, cada uno con su función:

• Texto. El contenido principal contra el que se comparan las consultas. Que sea la frase que tus usuarios buscarían de verdad.

• Descripción (opcional). Contexto extra: sinónimos, características, otras formas de decirlo. Alimenta la coincidencia semántica, no el resultado visible.

• Parámetros (opcional). JSON o texto que se devuelve intacto con cada coincidencia: ids, URLs, precios… lo que tu aplicación necesite para pintar el resultado.

{
  "text": "Sony WH-1000XM5 wireless headphones",
  "description": "Noise-cancelling over-ear headphones, 30h battery, Bluetooth 5.2",
  "params": {
    "sku": "SONY-XM5",
    "url": "/products/sony-wh-1000xm5",
    "price": 348
  }
}

El texto es lo que buscan los usuarios; la descripción aporta significado; los parámetros permiten a tu aplicación enlazar directamente al producto.

Desde la lista, «Importar desde archivo» acepta un archivo JSON con una lista de objetos. Solo «text» es obligatorio; «description» y «params» son opcionales.

[
  {
    "text": "Sony WH-1000XM5 wireless headphones",
    "description": "Noise-cancelling over-ear headphones",
    "params": { "sku": "SONY-XM5" }
  },
  {
    "text": "Logitech MX Master 3S mouse",
    "params": { "sku": "LOGI-MX3S" }
  },
  { "text": "USB-C 100W charging cable" }
]