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 array de objetos IProductsEntity.

Produtos.getProductsByVectorSearch(

body*, body.queryText*, body.vectorDistanceThreshold, body.maxHits, body.debug, langCode, offset, limit

);

Esquema de parâmetros

Esquema

body(obrigatório): IVectorSearchProducts
Corpo da busca vetorial. Exemplo: { queryText: "tênis de corrida vermelhos" }

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: "pt_BR"
exemplo: "pt_BR"

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

[
  {
    "id": 1764,
    "localizeInfos": {
      "title": "Red running shoes"
    },
    "price": 100,
    "additional": {
      "prices": {
        "min": 0,
        "max": 100
      }
    },
    "isVisible": true,
    "isSync": true,
    "sku": "0-123",
    "attributeValues": {},
    "attributeSetIdentifier": "my-set",
    "statusIdentifier": "in_stock",
    "statusLocalizeInfos": {
      "title": "In stock"
    },
    "position": 1
  }
]

Esquema de resposta

Esquema: IProductsEntity[]

[]: IProductsEntity
Uma entidade de produto.

[].id: number
O identificador único.
exemplo: 12345

[].localizeInfos: ILocalizeInfo
O nome localizado do produto.
exemplo: { "title": "Tênis de corrida vermelhos" }

[].price: number | null
O preço da página do produto retirado do índice.
exemplo: 100

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

[].attributeValues: IAttributeValues
Array de valores de atributos do índice.

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

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

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

---