getUsersByVectorSearch

Tìm kiếm người dùng theo ngữ nghĩa (vector). 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này thực hiện tìm kiếm ngữ nghĩa (vector) cho người dùng từ một truy vấn bằng ngôn ngữ tự nhiên - nó khớp với ý nghĩa thay vì từ khóa chính xác. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IUsersResponse - một container với items (các người dùng) và total.

Users.getUsersByVectorSearch(

body*, langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

body(bắt buộc): IUsersVectorSearch
Nội dung tìm kiếm vector
ví dụ:

{ queryText: "john" }

body.queryText(bắt buộc): string
Truy vấn tìm kiếm bằng ngôn ngữ tự nhiên.
ví dụ: "john"

body.vectorDistanceThreshold: number
Ghi đè ngưỡng khoảng cách cosine (0..2).
ví dụ: 0.3

body.maxHits: number
Các ứng viên hàng đầu được lấy trước khi phân trang. Mặc định: 100. Tối đa: 500.
ví dụ: 10

body.debug: boolean
Khi true, mỗi mục trả về sẽ có một trường distance.
ví dụ: false

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0

limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30

Ví dụ

Ví dụ tối thiểu

const response = await Users.getUsersByVectorSearch({ queryText: 'john' });

Ví dụ với thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IUsersResponse

items: IUserEntity[]
Mảng các đối tượng người dùng đã tìm thấy.

items.id: number
Định danh đối tượng.
ví dụ: 12345

items.identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "user_12345"

items.authProviderIdentifier: string
Định danh văn bản của nhà cung cấp xác thực.
ví dụ: "auth_provider_12345"

items.formData: FormDataType[]
Mảng các đối tượng dữ liệu biểu mẫu với các giá trị sau.
ví dụ:

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

items.formIdentifier: string
Định danh văn bản của biểu mẫu.
ví dụ: "form_12345"

items.total: string
Giá trị tổng cộng.
ví dụ: "0"

items.groups: Array<string | number>
Mảng các nhóm người dùng.
ví dụ:

[
  "group_1",
  "group_2"
]

items.state: object
Đối tượng chứa thông tin trạng thái người dùng bổ sung.
ví dụ:

{
  "key": "value"
}

items.moduleFormConfigs: Array<IFormConfig>
Mảng tùy chọn các đối tượng cấu hình biểu mẫu liên quan đến người dùng.

items.rating: IRating
Dữ liệu đánh giá.

items.distance: number
Khoảng cách cosine đến truy vấn. Chỉ được trả về bởi điểm cuối tìm kiếm ngữ nghĩa (vector) khi debug: true được truyền vào nội dung tìm kiếm.
ví dụ: 0.12

total: number
Tổng số bản ghi đã tìm thấy.
ví dụ: 100

ℹ️ Tìm kiếm ngữ nghĩa khớp với ý nghĩa, không phải với văn bản nguyên văn. Để khớp từ khóa trên mọi loại thực thể cùng một lúc, hãy sử dụng globalSearch().

---