getProductsByVectorSearch

Busca semântica (vetorial) para produtos.

Descrição

Este método realiza uma busca semântica (vetorial) para produtos a partir de uma consulta em linguagem natural - ele corresponde ao significado em vez de palavras-chave exatas. Retorna uma Promise que resolve para um objeto IProductsResponse - um contêiner com items (os produtos) e total - não um array simples.

Produtos.getProductsByVectorSearch(

body*, langCode, offset, limit

);

Esquema de parâmetros

Esquema

body(obrigatório): IVectorSearchProducts
Corpo da busca vetorial
exemplo:

{ queryText: "red running shoes" }

body.queryText(obrigatório): string
Consulta de busca em linguagem natural.
exemplo: "tênis de corrida vermelhos"

body.vectorDistanceThreshold: number
Distância vetorial máxima para um acerto.
exemplo: 0.5

body.maxHits: number
Número máximo de acertos a retornar.
exemplo: 50

body.debug: boolean
Incluir informações de depuração na resposta.
exemplo: false

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IProductsResponse

total: number
O número total de produtos encontrados.
exemplo: 100

items: IProductsEntity[]
Um array de entidades de produtos.
exemplo:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

items.id: number
O identificador único.
exemplo: 12345

items.localizeInfos: ILocalizeInfo
O nome dos produtos, levando em conta a localização.
exemplo:

{}

items.statusIdentifier: string | null
Identificadores de status da página do produto (pode ser nulo).
exemplo: "em_estoque"

items.statusLocalizeInfos: ILocalizeInfo
Nome do status localizado para o produto.
exemplo:

{ "title": "Sale" }

items.attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "set_12345"

items.position: number
Número do item (para ordenação).
exemplo: 1

items.price: number | null
O valor do preço da página do produto retirado do índice.
exemplo: 150.00

items.additional: object
Valor adicional do índice.
exemplo:

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

items.sku: string | null
SKU do produto (Unidade de Manutenção de Estoque), pode ser nulo.
exemplo: "SKU_12345"

items.isSync: boolean
Indicação de indexação da página.
exemplo: true

items.attributeValues: IAttributeValues
Array de valores de atributos do índice, representados.
exemplo:

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

items.categories: string[]
Categorias de produtos.
exemplo:

[
  1,
  2,
  3
]

items.isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

items.moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo (opcional).

items.rating: IRating
Dados de avaliação.

items.isPositionLocked: boolean
Indicador de bloqueio da posição de ordenação (opcional).
exemplo: false

items.relatedIds: number[]
IDs das páginas de produtos relacionadas.
exemplo:

[
  12345,
  67890
]

items.paymentStages: unknown
Dados das etapas de pagamento (pode ser nulo).
exemplo: null

items.distance: number
Distância de relevância da busca vetorial (semântica). Presente apenas nos resultados da busca vetorial.
exemplo: 0.42

items.discountConfig: Record<string, unknown>
Objeto de configuração de desconto.
exemplo:

{}

items.templateIdentifier: string | null
ID do usuário do template vinculado.
exemplo: "template_12345"

items.shortDescTemplateIdentifier: string | null
ID do usuário do template vinculado para uma descrição curta.
exemplo: "short_desc_template_12345"

items.signedPrice: string
O preço assinado do produto é obtido junto com os dados do produto quando signPrice está definido.
veja: Preço fixo do produto
exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

items.productPages: IProductPageRef[]
Array de referências de páginas de produtos vinculando o produto às suas páginas.
exemplo:

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

items.blocks: string[]
Array de identificadores de blocos.
exemplo:

[
  "block_12345",
  "block_67890"
]

totalFound: number
Número de produtos correspondidos antes que os limites sejam aplicados; retornado pelos endpoints de produtos em bloco (similarProducts, recomendações de carrinho/lista de desejos, pedidos frequentes). Opcional.
exemplo: 2

🔒 signedPrice é o token assinado que carrega o preço bloqueado — passe-o de volta quando você criar um pedido. Veja Preço fixo do produto (signedPrice).

---