getAdminsByVectorSearch

Recherche sémantique (vectorielle) pour les admins.

Description

Cette méthode effectue une recherche sémantique (vectorielle) pour les admins à partir d'une requête en langage naturel - elle correspond au sens plutôt qu'aux mots-clés exacts. Elle renvoie une promesse qui se résout en un objet IAdminsResponse - un conteneur avec items (les admins) et total - pas un tableau nu.

Admins.getAdminsByVectorSearch(

body*, langCode, offset, limit

);

Schéma des paramètres

Schéma

body(obligatoire): IAdminsVectorSearch
Corps de la recherche vectorielle
exemple :

{ queryText: "content manager" }

body.queryText(obligatoire): string
Requête de recherche en langage naturel.
exemple : "gestionnaire de contenu"

body.vectorDistanceThreshold: number
Remplacement du seuil de distance cosinus (0..2).
exemple : 0.3

body.maxHits: number
Top-K candidats récupérés avant la pagination. Par défaut : 100. Max : 500.
exemple : 10

body.debug: boolean
Lorsque vrai, chaque élément retourné obtient un champ distance.
exemple : false

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset: number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Exemples

Exemple minimal

const response = await Admins.getAdminsByVectorSearch({ queryText: 'content manager' });

Exemple avec des attributs

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

Exemple de réponse

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

Schéma de réponse

Schéma : IAdminsResponse

items: IAdminEntity[]
Tableau d'objets admin trouvés.

items.id: number
L'identifiant de l'objet.
exemple : 1764

items.attributeSetId: number | null
L'identifiant de l'ensemble d'attributs utilisé.
exemple : 120

items.identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "admin1"

items.attributeSetIdentifier: string | null
L'identifiant de l'ensemble d'attributs.
exemple : "admins"

items.position: number | null
Numéro de position (pour le tri).
exemple : 1

items.isSync: boolean
Indicateur d'indexation de la page (vrai ou faux).
exemple : true

items.attributeValues: IAttributeValues
Tableau de valeurs d'attributs de l'index (présenté comme une paire d'identifiant d'attribut utilisateur : valeur d'attribut).
exemple :

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

items.moduleFormConfigs: IFormConfig[]
Tableau de configurations de formulaires de module associées à l'admin.

items.moduleFormConfigs.id: number
L'identifiant de la configuration de formulaire.
exemple : 123

items.moduleFormConfigs.formIdentifier: string
L'identifiant du formulaire (uniquement dans l'API produits/pages).
exemple : "review"

items.moduleFormConfigs.moduleIdentifier: string
L'identifiant du module associé à la configuration de formulaire.
exemple : "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
Indique si la configuration de formulaire est globale.
exemple : true

items.moduleFormConfigs.isClosed: boolean
Indique si la configuration de formulaire est fermée.
exemple : true

items.moduleFormConfigs.isModerate: boolean
Indique si le formulaire nécessite une modération (uniquement dans l'API produits/pages).
exemple : false

items.moduleFormConfigs.viewOnlyUserData: boolean
Indique si la configuration de formulaire permet de visualiser les données utilisateur (utilisé dans l'API des formulaires).
exemple : true

items.moduleFormConfigs.commentOnlyUserData: boolean
Indique si la configuration de formulaire permet de commenter les données utilisateur (utilisé dans l'API des formulaires).
exemple : true

items.moduleFormConfigs.viewOnlyMyData: boolean
Indique si la configuration de formulaire permet de visualiser mes données (utilisé dans l'API produits/pages).
exemple : false

items.moduleFormConfigs.commentOnlyMyData: boolean
Indique si la configuration de formulaire permet de commenter mes données (utilisé dans l'API produits/pages).
exemple : false

items.moduleFormConfigs.entityIdentifiers: object[]
Un tableau d'identifiants d'entités associés à la configuration de formulaire.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
Un tableau de chaînes d'identifiants d'entités imbriquées (uniquement dans l'API produits/pages).
exemple : ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
Un tableau d'identifiants d'exception.

items.moduleFormConfigs.formDataCount: number
Nombre total d'entrées de données de formulaire (uniquement dans l'API produits/pages).
exemple : 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
Nombre de données de formulaire par identifiant d'entité (uniquement dans l'API produits/pages).
exemple :

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
Indique si cette configuration de formulaire est pour des évaluations.
exemple : null

items.moduleFormConfigs.isAnonymous: boolean | null
Indique si les soumissions anonymes sont autorisées.
exemple : null

items.moduleFormConfigs.allowHalfRatings: boolean | null
Indique si les demi-évaluations sont autorisées.
exemple : null

items.moduleFormConfigs.allowRerating: boolean | null
Indique si la réévaluation est autorisée.
exemple : null

items.moduleFormConfigs.maxRatingScale: number | null
Valeur maximale de l'échelle d'évaluation.
exemple : 5

items.moduleFormConfigs.ratingCalculation: string
Méthode de calcul des évaluations.
exemple : "average"
items.distance: number
Distance cosinus par rapport à la requête. Renvoie uniquement par le point de terminaison de recherche sémantique (vectorielle) lorsque debug: true est passé dans le corps de la recherche.
exemple : 0.12

total: number
Nombre total d'enregistrements trouvés.
exemple : 100

ℹ️ La recherche sémantique correspond au sens, et non au texte littéral. Pour une correspondance de mots-clés sur chaque type d'entité à la fois, utilisez globalSearch().

---