getAdminsByVectorSearch

Pencarian semantik (vektor) untuk admin.

Deskripsi

Metode ini melakukan pencarian semantik (vektor) untuk admin dari kueri bahasa alami - ini mencocokkan makna daripada kata kunci yang tepat. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IAdminsResponse - sebuah wadah dengan items (admin) dan total - bukan array kosong.

Admins.getAdminsByVectorSearch(
body*,
langCode,
offset,
limit
);

Skema parameter

Skema

body(required): IAdminsVectorSearch
Isi pencarian vektor
contoh:

{ queryText: "content manager" }

body.queryText(required): string
Kuery pencarian dalam bahasa alami.
contoh: "content manager"

body.vectorDistanceThreshold: number
Override ambang jarak kosinus (0..2).
contoh: 0.3

body.maxHits: number
Top-K kandidat yang diambil sebelum paginasi. Default: 100. Max: 500.
contoh: 10

body.debug: boolean
Ketika true, setiap item yang dikembalikan mendapatkan field distance.
contoh: false

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter untuk paginasi. Default: 30
contoh: 30

Contoh

Contoh minimal

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

Contoh dengan atribut

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

Contoh respons

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

Skema respons

Skema: IAdminsResponse

items: IAdminEntity[]
Array objek admin yang ditemukan.

items.id: number
Identifikasi objek.
contoh: 1764

items.attributeSetId: number | null
Identifikasi set atribut yang digunakan.
contoh: 120

items.identifier: string
Identifikasi tekstual untuk field record.
contoh: "admin1"

items.attributeSetIdentifier: string | null
Identifikasi set atribut.
contoh: "admins"

items.position: number | null
Nomor posisi (untuk pengurutan).
contoh: 1

items.isSync: boolean
Flag pengindeksan halaman (true atau false).
contoh: true

items.attributeValues: IAttributeValues
Array nilai atribut dari indeks (diajukan sebagai pasangan identifikasi atribut pengguna: nilai atribut).
contoh:

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

items.moduleFormConfigs: IFormConfig[]
Array konfigurasi form modul yang terkait dengan admin.

items.moduleFormConfigs.id: number
Identifikasi konfigurasi form.
contoh: 123

items.moduleFormConfigs.formIdentifier: string
Identifikasi form (hanya di API produk/halaman).
contoh: "review"

items.moduleFormConfigs.moduleIdentifier: string
Identifikasi modul yang terkait dengan konfigurasi form.
contoh: "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
Menunjukkan apakah konfigurasi form bersifat global.
contoh: true

items.moduleFormConfigs.isClosed: boolean
Menunjukkan apakah konfigurasi form ditutup.
contoh: true

items.moduleFormConfigs.isModerate: boolean
Menunjukkan apakah form memerlukan moderasi (hanya di API produk/halaman).
contoh: false

items.moduleFormConfigs.viewOnlyUserData: boolean
Menunjukkan apakah konfigurasi form memungkinkan melihat data pengguna (digunakan di API form).
contoh: true

items.moduleFormConfigs.commentOnlyUserData: boolean
Menunjukkan apakah konfigurasi form memungkinkan mengomentari data pengguna (digunakan di API form).
contoh: true

items.moduleFormConfigs.viewOnlyMyData: boolean
Menunjukkan apakah konfigurasi form memungkinkan melihat data saya (digunakan di API produk/halaman).
contoh: false

items.moduleFormConfigs.commentOnlyMyData: boolean
Menunjukkan apakah konfigurasi form memungkinkan mengomentari data saya (digunakan di API produk/halaman).
contoh: false

items.moduleFormConfigs.entityIdentifiers: object[]
Array identifikasi entitas yang terkait dengan konfigurasi form.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
Array string identifikasi entitas bersarang (hanya di API produk/halaman).
contoh: ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
Array identifikasi pengecualian.

items.moduleFormConfigs.formDataCount: number
Total jumlah entri data form (hanya di API produk/halaman).
contoh: 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
Jumlah data form per identifikasi entitas (hanya di API produk/halaman).
contoh:

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
Menunjukkan apakah konfigurasi form ini untuk penilaian.
contoh: null

items.moduleFormConfigs.isAnonymous: boolean | null
Menunjukkan apakah pengiriman anonim diizinkan.
contoh: null

items.moduleFormConfigs.allowHalfRatings: boolean | null
Menunjukkan apakah penilaian setengah diizinkan.
contoh: null

items.moduleFormConfigs.allowRerating: boolean | null
Menunjukkan apakah penilaian ulang diizinkan.
contoh: null

items.moduleFormConfigs.maxRatingScale: number | null
Nilai maksimum skala penilaian.
contoh: 5

items.moduleFormConfigs.ratingCalculation: string
Metode perhitungan penilaian.
contoh: "average"
items.distance: number
Jarak kosinus ke kueri. Hanya dikembalikan oleh endpoint pencarian semantik (vektor) ketika debug: true diteruskan dalam isi pencarian.
contoh: 0.12

total: number
Total jumlah record yang ditemukan.
contoh: 100

ℹ️ Pencarian semantik mencocokkan pada makna, bukan pada teks literal. Untuk pencocokan kata kunci di seluruh jenis entitas sekaligus gunakan globalSearch().

Deskripsi​

Skema parameter​

Contoh​

Contoh minimal​

Contoh dengan atribut​

Contoh respons​

Skema respons​