getProductsByVectorSearch

Búsqueda semántica (vectorial) de productos.

Descripción

Este método realiza una búsqueda semántica (vectorial) de productos a partir de una consulta en lenguaje natural; coincide con el significado en lugar de palabras clave exactas. Devuelve una Promesa que se resuelve en un array de objetos IProductsEntity.

Products.getProductsByVectorSearch(

body*, langCode, offset, limit

);

Esquema de parámetros

Esquema

body(required): IVectorSearchProducts
Cuerpo de búsqueda vectorial
ejemplo:

{ queryText: "red running shoes" }

body.queryText(required): string
Consulta de búsqueda en lenguaje natural.
ejemplo: "zapatillas rojas para correr"

body.vectorDistanceThreshold: number
Distancia máxima del vector para un acierto.
ejemplo: 0.5

body.maxHits: number
Número máximo de aciertos a devolver.
ejemplo: 50

body.debug: boolean
Incluir información de depuración en la respuesta.
ejemplo: false

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
Parámetro para paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro para paginación. Predeterminado: 30
ejemplo: 30

Ejemplos

Ejemplo mínimo

const response = await Products.getProductsByVectorSearch({ queryText: 'red running shoes' });

Ejemplo con atributos

const response = await Products.getProductsByVectorSearch(
  {
    queryText: 'red running shoes',
    vectorDistanceThreshold: 0.5,
    maxHits: 50,
  },
  'en_US',
  0,
  30,
);

Ejemplo de respuesta

{
  "items": [
    {
      "id": 2957,
      "attributeSetIdentifier": "products",
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "isVisible": true,
      "statusIdentifier": "sale",
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "sku": null,
      "isSync": true,
      "categories": [
        "catalog"
      ],
      "paymentStages": null,
      "rating": {},
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 150,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": "",
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": false
        }
      },
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 538,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 538
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {},
      "isPositionLocked": false
    }
  ],
  "total": 1
}

Esquema de respuesta

Esquema: IProductsEntity[]

id: number
El identificador único.
ejemplo: 12345

localizeInfos: ILocalizeInfo
El nombre de los productos, teniendo en cuenta la localización.
ejemplo:

{}

statusIdentifier: string | null
Identificadores de estado de la página del producto (puede ser nulo).
ejemplo: "in_stock"

statusLocalizeInfos: ILocalizeInfo
Nombre de estado localizado para el producto.
ejemplo:

{ "title": "Sale" }

attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "set_12345"

position: number
Número del ítem (para ordenación).
ejemplo: 1

price: number | null
El valor del precio de la página del producto tomado del índice.
ejemplo: 150.00

additional: object
Valor adicional del índice.
ejemplo:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

sku: string | null
SKU del producto (Unidad de Mantenimiento de Stock), puede ser nulo.
ejemplo: "SKU_12345"

isSync: boolean
Indicación de indexación de la página.
ejemplo: true

attributeValues: IAttributeValues
Array de valores de atributos del índice, representados.
ejemplo:

[
  {
    "id": "color",
    "value": "red"
  }
]

categories: string[]
Categorías de productos.
ejemplo:

[
  1,
  2,
  3
]

isVisible: boolean
Un signo de visibilidad de la página.
ejemplo: true

moduleFormConfigs: Array<IFormConfig>
Configuraciones de formularios del módulo (opcional).

rating: IRating
Datos de calificación.

isPositionLocked: boolean
Indicador de bloqueo de posición de ordenación (opcional).
ejemplo: false

relatedIds: number[]
IDs de páginas de productos relacionadas.
ejemplo:

[
  12345,
  67890
]

paymentStages: unknown
Datos de etapas de pago (puede ser nulo).
ejemplo: null

distance: number
Distancia de relevancia de búsqueda vectorial (semántica). Presente solo en resultados de búsqueda vectorial.
ejemplo: 0.42

discountConfig: Record<string, unknown>
Objeto de configuración de descuento.
ejemplo:

{}

templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: "template_12345"

shortDescTemplateIdentifier: string | null
ID de usuario de la plantilla vinculada para una descripción corta.
ejemplo: "short_desc_template_12345"

signedPrice: string
El precio firmado del producto se obtiene junto con los datos del producto cuando signPrice está configurado.
ejemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

productPages: IProductPageRef[]
Array de referencias de páginas de productos que vinculan el producto a sus páginas.
ejemplo:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

productPages.id: number
Identificador único del registro de enlace producto-página.
ejemplo: 16

productPages.pageId: number
Identificador de la página a la que está vinculado el producto.
ejemplo: 4

productPages.productId: number
Identificador del producto.
ejemplo: 15

productPages.positionId: number
Identificador de posición de ordenación dentro de la página.
ejemplo: 244

productPages.categoryPath: string
Ruta de categoría de la página a la que pertenece el producto.
ejemplo: "products"

blocks: string[]
Array de identificadores de bloques.
ejemplo:

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice es el token firmado que lleva el precio bloqueado; devuélvelo cuando crees un pedido. Consulta Precio de producto fijo (signedPrice).

---