getUsersByVectorSearch

Pencarian semantik (vektor) untuk pengguna. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

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

Users.getUsersByVectorSearch(

body*, langCode, offset, limit

);

Skema parameter

Skema

body(required): IUsersVectorSearch
Isi pencarian vektor
contoh:

{ queryText: "john" }

body.queryText(required): string
Kueri pencarian dalam bahasa alami.
contoh: "john"

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

body.maxHits: number
Kandidat Top-K 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 Users.getUsersByVectorSearch({ queryText: 'john' });

Contoh dengan atribut

const response = await Users.getUsersByVectorSearch(
  {
    queryText: 'john',
    vectorDistanceThreshold: 0.3,
    maxHits: 50,
    debug: true,
  },
  'en_US',
  0,
  30,
);

Contoh respons

{
  "items": [
    {
      "id": 8,
      "total": "1",
      "identifier": "test@test.ru",
      "authProviderIdentifier": "email",
      "formData": [
        {
          "marker": "name_reg",
          "type": "string",
          "value": "Ivan"
        },
        {
          "marker": "phone_reg",
          "type": "string",
          "value": "+19258382556"
        }
      ],
      "formIdentifier": "reg",
      "groups": [
        1
      ],
      "state": {},
      "rating": {},
      "moduleFormConfigs": []
    }
  ],
  "total": 1
}

Skema respons

Skema: IUsersResponse

items: IUserEntity[]
Array objek pengguna yang ditemukan.

items.id: number
Identifikasi objek.
contoh: 12345

items.identifier: string
Identifikasi teks untuk field catatan.
contoh: "user_12345"

items.authProviderIdentifier: string
Identifikasi teks dari penyedia otentikasi.
contoh: "auth_provider_12345"

items.formData: FormDataType[]
Array objek data formulir dengan nilai-nilai berikut.
contoh:

[
  {
    "marker": "last_name",
    "type": "string",
    "value": "Username"
  }
]

items.formIdentifier: string
Identifikasi teks dari formulir.
contoh: "form_12345"

items.total: string
Nilai total.
contoh: "0"

items.groups: Array<string | number>
Array grup pengguna.
contoh:

[
  "group_1",
  "group_2"
]

items.state: object
Objek yang berisi informasi tambahan tentang status pengguna.
contoh:

{
  "key": "value"
}

items.moduleFormConfigs: Array<IFormConfig>
Array opsional dari objek konfigurasi formulir yang terkait dengan pengguna.

items.rating: IRating
Data penilaian.

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
Jumlah total catatan yang ditemukan.
contoh: 100

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

---