getAdminsByVectorSearch

Búsqueda semántica (vectorial) para administradores.

Descripción

Este método realiza una búsqueda semántica (vectorial) para administradores a partir de una consulta en lenguaje natural; se basa en el significado en lugar de en palabras clave exactas. Devuelve una Promesa que se resuelve en un objeto IAdminsResponse, que es un contenedor con items (los administradores) y total, no un array simple.

Admins.getAdminsByVectorSearch(

body*, langCode, offset, limit

);

Esquema de parámetros

Esquema

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

{ queryText: "content manager" }

body.queryText(required): string
Consulta de búsqueda en lenguaje natural.
ejemplo: "gestor de contenido"

body.vectorDistanceThreshold: number
Anulación del umbral de distancia coseno (0..2).
ejemplo: 0.3

body.maxHits: number
Candidatos Top-K obtenidos antes de la paginación. Predeterminado: 100. Máx: 500.
ejemplo: 10

body.debug: boolean
Cuando es verdadero, cada elemento devuelto obtiene un campo distance.
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 Admins.getAdminsByVectorSearch({ queryText: 'content manager' });

Ejemplo con atributos

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

Ejemplo de respuesta

{
  "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 respuesta

Esquema: IAdminsResponse

items: IAdminEntity[]
Array de objetos de administrador encontrados.

items.id: number
El identificador del objeto.
ejemplo: 1764

items.attributeSetId: number | null
El identificador del conjunto de atributos que se está utilizando.
ejemplo: 120

items.identifier: string
El identificador textual para el campo del registro.
ejemplo: "admin1"

items.attributeSetIdentifier: string | null
El identificador del conjunto de atributos.
ejemplo: "admins"

items.position: number | null
Número de posición (para ordenación).
ejemplo: 1

items.isSync: boolean
Indicador de indexación de página (verdadero o falso).
ejemplo: true

items.attributeValues: IAttributeValues
Array de valores de atributos del índice (presentados como un par de identificador de atributo de usuario: valor de atributo).
ejemplo:

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

items.moduleFormConfigs: IFormConfig[]
Array de configuraciones de formularios de módulo asociadas con el administrador.

items.moduleFormConfigs.id: number
El identificador de la configuración del formulario.
ejemplo: 123

items.moduleFormConfigs.formIdentifier: string
El identificador del formulario (solo en la API de productos/páginas).
ejemplo: "review"

items.moduleFormConfigs.moduleIdentifier: string
El identificador del módulo asociado con la configuración del formulario.
ejemplo: "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
Indica si la configuración del formulario es global.
ejemplo: true

items.moduleFormConfigs.isClosed: boolean
Indica si la configuración del formulario está cerrada.
ejemplo: true

items.moduleFormConfigs.isModerate: boolean
Indica si el formulario requiere moderación (solo en la API de productos/páginas).
ejemplo: false

items.moduleFormConfigs.viewOnlyUserData: boolean
Indica si la configuración del formulario permite ver datos de usuario (utilizado en la API de formularios).
ejemplo: true

items.moduleFormConfigs.commentOnlyUserData: boolean
Indica si la configuración del formulario permite comentar sobre datos de usuario (utilizado en la API de formularios).
ejemplo: true

items.moduleFormConfigs.viewOnlyMyData: boolean
Indica si la configuración del formulario permite ver mis datos (utilizado en la API de productos/páginas).
ejemplo: false

items.moduleFormConfigs.commentOnlyMyData: boolean
Indica si la configuración del formulario permite comentar sobre mis datos (utilizado en la API de productos/páginas).
ejemplo: false

items.moduleFormConfigs.entityIdentifiers: object[]
Un array de identificadores de entidad asociados con la configuración del formulario.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
Un array de cadenas de identificadores de entidades anidadas (solo en la API de productos/páginas).
ejemplo: ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
Un array de identificadores de excepciones.

items.moduleFormConfigs.formDataCount: number
Conteo total de entradas de datos del formulario (solo en la API de productos/páginas).
ejemplo: 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
Conteo de datos del formulario por identificador de entidad (solo en la API de productos/páginas).
ejemplo:

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
Indica si esta configuración de formulario es para calificaciones.
ejemplo: null

items.moduleFormConfigs.isAnonymous: boolean | null
Indica si se permiten envíos anónimos.
ejemplo: null

items.moduleFormConfigs.allowHalfRatings: boolean | null
Indica si se permiten calificaciones medias.
ejemplo: null

items.moduleFormConfigs.allowRerating: boolean | null
Indica si se permite volver a calificar.
ejemplo: null

items.moduleFormConfigs.maxRatingScale: number | null
Valor máximo de la escala de calificación.
ejemplo: 5

items.moduleFormConfigs.ratingCalculation: string
Método de cálculo de calificación.
ejemplo: "promedio"
items.distance: number
Distancia coseno a la consulta. Devuelto solo por el punto final de búsqueda semántica (vectorial) cuando se pasa debug: true en el cuerpo de búsqueda.
ejemplo: 0.12

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

ℹ️ La búsqueda semántica se basa en el significado, no en el texto literal. Para coincidencias de palabras clave en todos los tipos de entidades a la vez, utiliza globalSearch().

---