Pular para o conteúdo principal

getAdminsByVectorSearch

Busca semântica (vetorial) para admins.

Descrição​

Este método realiza uma busca semântica (vetorial) para admins 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 IAdminsResponse - um contêiner com items (os admins) e total - não um array simples.

.getAdminsByVectorSearch(

, , ,

);

Esquema de parâmetros​

Esquema

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

{ queryText: "content manager" }

body.queryText(obrigatório): string
Consulta de busca em linguagem natural.
exemplo: "gerente de conteúdo"

body.vectorDistanceThreshold: number
Substituição do limite de distância do cosseno (0..2).
exemplo: 0.3

body.maxHits: number
Candidatos Top-K buscados antes da paginação. Padrão: 100. Máx: 500.
exemplo: 10

body.debug: boolean
Quando verdadeiro, cada item retornado recebe um campo distance.
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 Admins.getAdminsByVectorSearch({ queryText: 'content manager' });

Exemplo com atributos​

const response = await Admins.getAdminsByVectorSearch(
  {
    queryText: 'content manager',
    vectorDistanceThreshold: 0.3,
    maxHits: 50,
    debug: true,
  },
  'en_US',
  0,
  30,
);

Exemplo de resposta​

{
  "items": [],
  "total": 0,
  "indexReady": false
}

Esquema de resposta​

Esquema: IAdminsResponse

items: IAdminEntity[]
Array de objetos admin encontrados.

items.id: number
O identificador do objeto.
exemplo: 1764

items.attributeSetId: number | null
O identificador do conjunto de atributos sendo usado.
exemplo: 120

items.identifier: string
O identificador textual para o campo do registro.
exemplo: "admin1"

items.attributeSetIdentifier: string | null
O identificador do conjunto de atributos.
exemplo: "admins"

items.position: number | null
Número da posição (para ordenação).
exemplo: 1

items.isSync: boolean
Flag de indexação da página (verdadeiro ou falso).
exemplo: true

items.attributeValues: IAttributeValues
Array de valores de atributos do índice (apresentado como um par de identificador de atributo do usuário: valor do atributo).
exemplo:

[
  {
    "marker": {
      "type": "string",
      "value": "Some value"
    }
  }
]

items.moduleFormConfigs: IFormConfig[]
Array de configurações de formulário do módulo associadas ao admin.

items.distance: number
Distância do cosseno em relação à consulta. Retornado apenas pelo endpoint de busca semântica (vetorial) quando debug: true é passado no corpo da busca.
exemplo: 0.12

total: number
Número total de registros encontrados.
exemplo: 100

ℹ️ A busca semântica corresponde ao significado, não ao texto literal. Para correspondência de palavras-chave em todos os tipos de entidade de uma vez, use globalSearch().