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.

Admins.getAdminsByVectorSearch(

body*, langCode, offset, limit

);

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
Top-K candidatos 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ódig 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": [
    {
      "id": 1,
      "attributeSetId": 27,
      "identifier": "admin",
      "attributeSetIdentifier": "admins",
      "position": 1,
      "isSync": true,
      "attributeValues": {
        "admin-text": {
          "type": "string",
          "value": "",
          "position": 0,
          "additionalFields": {}
        }
      },
      "formModuleConfigs": []
    }
  ],
  "total": 1
}

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 (apresentados 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 de módulo associadas ao admin.

items.moduleFormConfigs.id: number
O identificador da configuração do formulário.
exemplo: 123

items.moduleFormConfigs.formIdentifier: string
O identificador do formulário (apenas na API de produtos/páginas).
exemplo: "review"

items.moduleFormConfigs.moduleIdentifier: string
O identificador do módulo associado à configuração do formulário.
exemplo: "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
Indica se a configuração do formulário é global.
exemplo: true

items.moduleFormConfigs.isClosed: boolean
Indica se a configuração do formulário está fechada.
exemplo: true

items.moduleFormConfigs.isModerate: boolean
Indica se o formulário requer moderação (apenas na API de produtos/páginas).
exemplo: false

items.moduleFormConfigs.viewOnlyUserData: boolean
Indica se a configuração do formulário permite visualizar dados do usuário (usado na API de formulários).
exemplo: true

items.moduleFormConfigs.commentOnlyUserData: boolean
Indica se a configuração do formulário permite comentar sobre dados do usuário (usado na API de formulários).
exemplo: true

items.moduleFormConfigs.viewOnlyMyData: boolean
Indica se a configuração do formulário permite visualizar meus dados (usado na API de produtos/páginas).
exemplo: false

items.moduleFormConfigs.commentOnlyMyData: boolean
Indica se a configuração do formulário permite comentar sobre meus dados (usado na API de produtos/páginas).
exemplo: false

items.moduleFormConfigs.entityIdentifiers: object[]
Um array de identificadores de entidades associados à configuração do formulário.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
Um array de strings de identificadores de entidades aninhadas (apenas na API de produtos/páginas).
exemplo: ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
Um array de identificadores de exceção.

items.moduleFormConfigs.formDataCount: number
Contagem total de entradas de dados do formulário (apenas na API de produtos/páginas).
exemplo: 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
Contagem de dados do formulário por identificador de entidade (apenas na API de produtos/páginas).
exemplo:

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
Indica se esta configuração de formulário é para avaliações.
exemplo: null

items.moduleFormConfigs.isAnonymous: boolean | null
Indica se envios anônimos são permitidos.
exemplo: null

items.moduleFormConfigs.allowHalfRatings: boolean | null
Indica se avaliações parciais são permitidas.
exemplo: null

items.moduleFormConfigs.allowRerating: boolean | null
Indica se reavaliações são permitidas.
exemplo: null

items.moduleFormConfigs.maxRatingScale: number | null
Valor máximo da escala de avaliação.
exemplo: 5

items.moduleFormConfigs.ratingCalculation: string
Método de cálculo da avaliação.
exemplo: "average"
items.distance: number
Distância 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
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 entidades de uma só vez, use globalSearch().

---