getAdminsByVectorSearch

Tìm kiếm ngữ nghĩa (vector) cho các quản trị viên.

Mô tả

Phương thức này thực hiện tìm kiếm ngữ nghĩa (vector) cho các quản trị viên 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 IAdminsResponse - một container với items (các quản trị viên) và total - không phải là một mảng trống.

Admins.getAdminsByVectorSearch(

body*, langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

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

{ queryText: "content manager" }

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

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

body.maxHits: number
Số lượng ứ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 Admins.getAdminsByVectorSearch({ queryText: 'content manager' });

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

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IAdminsResponse

items: IAdminEntity[]
Mảng các đối tượng quản trị viên đã tìm thấy.

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

items.attributeSetId: number | null
Định danh của bộ thuộc tính đang được sử dụng.
ví dụ: 120

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

items.attributeSetIdentifier: string | null
Định danh của bộ thuộc tính.
ví dụ: "admins"

items.position: number | null
Số thứ tự vị trí (để sắp xếp).
ví dụ: 1

items.isSync: boolean
Cờ chỉ mục trang (true hoặc false).
ví dụ: true

items.attributeValues: IAttributeValues
Mảng các giá trị thuộc tính từ chỉ mục (được trình bày dưới dạng cặp định danh thuộc tính người dùng: giá trị thuộc tính).
ví dụ:

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

items.moduleFormConfigs: IFormConfig[]
Mảng các cấu hình biểu mẫu mô-đun liên quan đến quản trị viên.

items.moduleFormConfigs.id: number
Định danh của cấu hình biểu mẫu.
ví dụ: 123

items.moduleFormConfigs.formIdentifier: string
Định danh biểu mẫu (chỉ trong API sản phẩm/trang).
ví dụ: "review"

items.moduleFormConfigs.moduleIdentifier: string
Định danh của mô-đun liên quan đến cấu hình biểu mẫu.
ví dụ: "module_identifier"

items.moduleFormConfigs.isGlobal: boolean
Chỉ ra liệu cấu hình biểu mẫu có phải là toàn cầu hay không.
ví dụ: true

items.moduleFormConfigs.isClosed: boolean
Chỉ ra liệu cấu hình biểu mẫu có bị đóng hay không.
ví dụ: true

items.moduleFormConfigs.isModerate: boolean
Chỉ ra liệu biểu mẫu có yêu cầu kiểm duyệt hay không (chỉ trong API sản phẩm/trang).
ví dụ: false

items.moduleFormConfigs.viewOnlyUserData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép xem dữ liệu người dùng hay không (sử dụng trong API biểu mẫu).
ví dụ: true

items.moduleFormConfigs.commentOnlyUserData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép bình luận về dữ liệu người dùng hay không (sử dụng trong API biểu mẫu).
ví dụ: true

items.moduleFormConfigs.viewOnlyMyData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép xem dữ liệu của tôi hay không (sử dụng trong API sản phẩm/trang).
ví dụ: false

items.moduleFormConfigs.commentOnlyMyData: boolean
Chỉ ra liệu cấu hình biểu mẫu có cho phép bình luận về dữ liệu của tôi hay không (sử dụng trong API sản phẩm/trang).
ví dụ: false

items.moduleFormConfigs.entityIdentifiers: object[]
Mảng các định danh thực thể liên quan đến cấu hình biểu mẫu.

items.moduleFormConfigs.nestedEntityIdentifiers: string[]
Mảng các chuỗi định danh thực thể lồng nhau (chỉ trong API sản phẩm/trang).
ví dụ: ["catalog"]

items.moduleFormConfigs.exceptionIds: string[]
Mảng các định danh ngoại lệ.

items.moduleFormConfigs.formDataCount: number
Tổng số lượng mục dữ liệu biểu mẫu (chỉ trong API sản phẩm/trang).
ví dụ: 306

items.moduleFormConfigs.entityFormDataCount: Record<string, number>
Số lượng dữ liệu biểu mẫu theo định danh thực thể (chỉ trong API sản phẩm/trang).
ví dụ:

{"catalog": 306}

items.moduleFormConfigs.isRating: boolean | null
Chỉ ra liệu cấu hình biểu mẫu này có dành cho đánh giá hay không.
ví dụ: null

items.moduleFormConfigs.isAnonymous: boolean | null
Chỉ ra liệu các bài nộp ẩn danh có được phép hay không.
ví dụ: null

items.moduleFormConfigs.allowHalfRatings: boolean | null
Chỉ ra liệu các đánh giá nửa có được phép hay không.
ví dụ: null

items.moduleFormConfigs.allowRerating: boolean | null
Chỉ ra liệu việc đánh giá lại có được phép hay không.
ví dụ: null

items.moduleFormConfigs.maxRatingScale: number | null
Giá trị tối đa của thang đánh giá.
ví dụ: 5

items.moduleFormConfigs.ratingCalculation: string
Phương pháp tính toán đánh giá.
ví dụ: "trung bình"
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().

---