getAdminsByVectorSearch

بحث دلالي (متجه) عن المسؤولين.

الوصف

تقوم هذه الطريقة بإجراء بحث دلالي (متجه) عن المسؤولين من استعلام بلغة طبيعية - حيث تتطابق على المعنى بدلاً من الكلمات الرئيسية الدقيقة. تعيد وعدًا (Promise) يتم حله إلى كائن IAdminsResponse - حاوية تحتوي على items (المسؤولين) و total - وليس مصفوفة عارية.

Admins.getAdminsByVectorSearch(

body*, langCode, offset, limit

);

مخطط المعاملات

المخطط

body(required): IAdminsVectorSearch
نص جسم البحث المتجه
مثال:

{ queryText: "content manager" }

body.queryText(required): string
استعلام البحث بلغة طبيعية.
مثال: "مدير محتوى"

body.vectorDistanceThreshold: number
تجاوز عتبة المسافة الكوسينية (0..2).
مثال: 0.3

body.maxHits: number
أفضل K مرشحين تم جلبهم قبل التصفح. الافتراضي: 100. الحد الأقصى: 500.
مثال: 10

body.debug: boolean
عند التفعيل، يحصل كل عنصر تم إرجاعه على حقل distance.
مثال: false

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

offset: number
معامل للتصفح. الافتراضي: 0
مثال: 0

limit: number
معامل للتصفح. الافتراضي: 30
مثال: 30

أمثلة

مثال بسيط

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

مثال مع السمات

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

مثال على الاستجابة

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

مخطط الاستجابة

المخطط: IAdminsResponse

items: IAdminEntity[]
مصفوفة من كائنات المسؤولين التي تم العثور عليها.

items.id: number
معرف الكائن.
مثال: 1764

items.attributeSetId: number | null
معرف مجموعة السمات المستخدمة.
مثال: 120

items.identifier: string
المعرف النصي لحقل السجل.
مثال: "admin1"

items.attributeSetIdentifier: string | null
معرف مجموعة السمات.
مثال: "admins"

items.position: number | null
رقم الموضع (للتصنيف).
مثال: 1

items.isSync: boolean
علامة فهرسة الصفحة (صحيح أو خطأ).
مثال: true

items.attributeValues: IAttributeValues
مصفوفة من قيم السمات من الفهرس (مقدمة كزوج من معرف سمة المستخدم: قيمة السمة).
مثال:

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

items.moduleFormConfigs: IFormConfig[]
مصفوفة من تكوينات نماذج الوحدة المرتبطة بالمسؤول.

items.moduleFormConfigs.id: number
معرف تكوين النموذج.
مثال: 123

items.moduleFormConfigs.formIdentifier: string
معرف النموذج (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: "مراجعة"

items.moduleFormConfigs.moduleIdentifier: string
معرف الوحدة المرتبطة بتكوين النموذج.
مثال: "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
تشير إلى ما إذا كان تكوين النموذج عالميًا.
مثال: true

items.moduleFormConfigs.isClosed: boolean
تشير إلى ما إذا كان تكوين النموذج مغلقًا.
مثال: true

items.moduleFormConfigs.isModerate: boolean
تشير إلى ما إذا كان النموذج يتطلب اعتدالًا (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

items.moduleFormConfigs.viewOnlyUserData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بعرض بيانات المستخدم (يستخدم في واجهة برمجة التطبيقات للنماذج).
مثال: true

items.moduleFormConfigs.commentOnlyUserData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بالتعليق على بيانات المستخدم (يستخدم في واجهة برمجة التطبيقات للنماذج).
مثال: true

items.moduleFormConfigs.viewOnlyMyData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بعرض بياناتي (يستخدم في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

items.moduleFormConfigs.commentOnlyMyData: boolean
تشير إلى ما إذا كان تكوين النموذج يسمح بالتعليق على بياناتي (يستخدم في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: false

items.moduleFormConfigs.entityIdentifiers: object[]
مصفوفة من معرفات الكيانات المرتبطة بتكوين النموذج.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
مصفوفة من سلاسل معرف الكيانات المتداخلة (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
مصفوفة من معرفات الاستثناءات.

items.moduleFormConfigs.formDataCount: number
إجمالي عدد إدخالات بيانات النموذج (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال: 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
عدد بيانات النموذج لكل معرف كيان (فقط في واجهة برمجة التطبيقات للمنتجات/الصفحات).
مثال:

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
تشير إلى ما إذا كان تكوين النموذج هذا مخصصًا للتقييمات.
مثال: null

items.moduleFormConfigs.isAnonymous: boolean | null
تشير إلى ما إذا كانت التقديمات المجهولة مسموح بها.
مثال: null

items.moduleFormConfigs.allowHalfRatings: boolean | null
تشير إلى ما إذا كانت التقييمات النصفية مسموح بها.
مثال: null

items.moduleFormConfigs.allowRerating: boolean | null
تشير إلى ما إذا كان إعادة التقييم مسموحًا به.
مثال: null

items.moduleFormConfigs.maxRatingScale: number | null
أقصى قيمة لمقياس التقييم.
مثال: 5

items.moduleFormConfigs.ratingCalculation: string
طريقة حساب التقييم.
مثال: "متوسط"
items.distance: number
المسافة الكوسينية إلى الاستعلام. يتم إرجاعها فقط من نقطة نهاية البحث الدلالي (المتجه) عندما يتم تمرير debug: true في جسم البحث.
مثال: 0.12

total: number
إجمالي عدد السجلات التي تم العثور عليها.
مثال: 100

ℹ️ يتطابق البحث الدلالي على المعنى، وليس على النص الحرفي. لاستخدام مطابقة الكلمات الرئيسية عبر كل نوع كيان مرة واحدة، استخدم globalSearch().

---