- Tài nguyên: SearchApplication
- DataSourceRestriction
- Nguồn
- Source.PredefinedSource
- FilterOptions
- Bộ lọc
- Filter.ValueFilter
- Giá trị
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Phương thức
Tài nguyên: SearchApplication (Ứng dụng tìm kiếm)
SearchApplication
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Các trường | |
---|---|
name |
Tên của Ứng dụng tìm kiếm. Định dạng: searchapplications/{applicationId}. |
displayName |
Tên hiển thị của Ứng dụng tìm kiếm. Độ dài tối đa là 300 ký tự. |
dataSourceRestrictions[] |
Các quy định hạn chế được áp dụng cho cấu hình. Số lượng phần tử tối đa là 10. |
sourceConfig[] |
Cấu hình cho một nguồn được chỉ định trong dataSourceRestrict (Hạn chế). |
scoringConfig |
Cấu hình của kết quả xếp hạng. |
defaultSortOptions |
Các chế độ mặc định để sắp xếp kết quả tìm kiếm |
defaultFacetOptions[] |
Các trường mặc định để trả về kết quả thuộc tính. Các nguồn được chỉ định ở đây cũng đã được đưa vào |
returnResultThumbnailUrls |
Với mỗi kết quả, chúng ta nên trả về URI cho hình thu nhỏ (nếu có) |
operationIds[] |
Chỉ có đầu ra. Mã nhận dạng của các hoạt động lâu dài (LRO) hiện đang chạy cho giản đồ này. Trường chỉ xuất. |
enableAuditLog |
Cho biết liệu tính năng ghi nhật ký kiểm tra có bật/tắt cho các yêu cầu được gửi cho ứng dụng tìm kiếm trong API truy vấn hay không. |
queryInterpretationConfig |
Các tuỳ chọn mặc định để diễn giải truy vấn |
DataSourceRestriction
Quy định hạn chế về Nguồn dữ liệu.
Biểu diễn dưới dạng JSON |
---|
{ "source": { object ( |
Các trường | |
---|---|
source |
Nguồn gốc của việc hạn chế. |
filterOptions[] |
Tuỳ chọn bộ lọc hạn chế kết quả. Nếu có nhiều bộ lọc, các bộ lọc này sẽ được nhóm theo loại đối tượng trước khi kết hợp. Các bộ lọc có cùng loại đối tượng được kết hợp liên tục, sau đó biểu thức kết quả được liên kết một cách gián đoạn. Số lượng phần tử tối đa là 20. LƯU Ý: Hiện tại, API Đề xuất chỉ hỗ trợ một vài bộ lọc: "objecttype", "type" và "mimetype". Hiện tại, bạn không thể dùng các bộ lọc cụ thể theo giản đồ để lọc các đề xuất. |
Nguồn
Xác định nguồn cho các API đề xuất/tìm kiếm.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Các trường | |
---|---|
Trường nhóm
|
|
name |
Tên nguồn của nội dung do |
predefinedSource |
Nguồn nội dung được xác định trước cho Google Apps. |
Source.PredefinedSource
Các nguồn được xác định trước:
Enum | |
---|---|
NONE |
|
QUERY_HISTORY |
Đề xuất các cụm từ tìm kiếm do người dùng đưa ra trước đây. Chỉ hợp lệ khi được sử dụng với API đề xuất. Bị bỏ qua khi dùng trong API truy vấn. |
PERSON |
Đề xuất người trong tổ chức. Chỉ hợp lệ khi được sử dụng với API đề xuất. Kết quả là một lỗi khi được dùng trong API truy vấn. |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
Các lựa chọn bộ lọc sẽ được áp dụng cho cụm từ tìm kiếm.
Biểu diễn dưới dạng JSON |
---|
{
"objectType": string,
"filter": {
object ( |
Các trường | |
---|---|
objectType |
Nếu bạn đặt objectType, thì chỉ các đối tượng thuộc loại đó mới được trả về. Tên này phải tương ứng với tên của đối tượng đã được đăng ký trong định nghĩa của giản đồ. Độ dài tối đa là 256 ký tự. |
filter |
Bộ lọc chung để hạn chế nội dung tìm kiếm, chẳng hạn như |
Lọc
Một cách chung để thể hiện các bộ lọc trong truy vấn, hỗ trợ hai phương pháp:
1. Đặt ValueFilter. Tên phải khớp với toán tửName được xác định trong giản đồ cho nguồn dữ liệu của bạn.
2. Cài đặt Bộ lọc tổng hợp. Các bộ lọc này được đánh giá bằng toán tử logic. Toán tử cấp cao nhất chỉ có thể là AND hoặc NOT. VÀ chỉ có thể xuất hiện ở cấp cao nhất. OR chỉ có thể xuất hiện trong ký tự AND cấp cao nhất.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Các trường | |
---|---|
Trường nhóm
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Biểu diễn dưới dạng JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Các trường | |
---|---|
operatorName |
|
value |
Giá trị cần so sánh. |
Giá trị
Định nghĩa về một giá trị duy nhất với loại chung.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Các trường | |
---|---|
Trường nhóm value . Giá trị của thuộc tính được đặt tên. value chỉ có thể là một trong những trạng thái sau đây: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Biểu diễn dưới dạng JSON |
---|
{ "logicOperator": enum ( |
Các trường | |
---|---|
logicOperator |
Toán tử logic của bộ lọc phụ. |
subFilters[] |
Bộ lọc phụ. |
Filter.CompositeFilter.LogicOperator
Enum | |
---|---|
AND |
Toán tử logic, chỉ có thể áp dụng cho bộ lọc phụ. |
OR |
|
NOT |
KHÔNG thể áp dụng chỉ một bộ lọc phụ. |
SourceConfig
Cấu hình cho một nguồn trong khi xử lý yêu cầu query.search
hoặc query.suggest
.
Biểu diễn dưới dạng JSON |
---|
{ "source": { object ( |
Các trường | |
---|---|
source |
Nguồn sẽ sử dụng cấu hình này. |
scoringConfig |
Cấu hình tính điểm cho nguồn. |
crowdingConfig |
Cấu hình chèn lấp cho nguồn. |
SourceScoringConfig
Đặt cấu hình tính điểm. Điều này cho phép sửa đổi thứ hạng của kết quả cho một nguồn.
Biểu diễn dưới dạng JSON |
---|
{
"sourceImportance": enum ( |
Các trường | |
---|---|
sourceImportance |
Tầm quan trọng của nguồn. |
SourceScoringConfig.SourceImportance
Tầm quan trọng của một nguồn có thể được sử dụng để cho biết liệu một nguồn có nên được ưu tiên hơn trong việc xếp hạng so với một nguồn khác hay không.
Enum | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Thiết lập giới hạn về tình trạng tải quá nhiều kết quả tìm kiếm. Chèn chồng là tình huống trong đó nhiều kết quả từ cùng một nguồn hoặc máy chủ lưu trữ "che lấp" các kết quả khác, làm giảm chất lượng tìm kiếm của người dùng. Để nâng cao chất lượng tìm kiếm và tính đa dạng của nguồn trong kết quả tìm kiếm, bạn có thể đặt một điều kiện để giảm số lượng kết quả trùng lặp theo nguồn.
Biểu diễn dưới dạng JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
Các trường | |
---|---|
numResults |
Số lượng kết quả tối đa được phép từ một nguồn dữ liệu trong một trang kết quả miễn là kết quả từ các nguồn khác chưa hết. Giá trị được chỉ định không được là số âm. Giá trị mặc định sẽ được sử dụng nếu giá trị này bằng 0. Để tắt tính năng gộp nhóm, hãy đặt giá trị lớn hơn 100. |
numSuggestions |
Số đề xuất tối đa được cho phép từ một nguồn. Sẽ không có giới hạn nào được đặt cho kết quả nếu giá trị này nhỏ hơn hoặc bằng 0. |
ScoringConfig
Tính điểm cấu hình cho một nguồn trong khi xử lý yêu cầu query.search
hoặc query.suggest
.
Biểu diễn dưới dạng JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Các trường | |
---|---|
disableFreshness |
Liệu có nên sử dụng độ mới làm tín hiệu xếp hạng hay không. Theo mặc định, độ mới được sử dụng làm tín hiệu xếp hạng. Xin lưu ý rằng chế độ cài đặt này không có trong Giao diện người dùng dành cho quản trị viên. |
disablePersonalization |
Liệu có cá nhân hoá kết quả hay không. Theo mặc định, các tín hiệu cá nhân sẽ được dùng để cải thiện kết quả. |
SortOptions
Biểu diễn dưới dạng JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Các trường | |
---|---|
operatorName |
Tên của toán tử tương ứng với trường cần sắp xếp. Thuộc tính tương ứng phải được đánh dấu là |
sortOrder |
Tăng dần là thứ tự sắp xếp mặc định |
SortOptions.SortOrder
Enum | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Chỉ định các toán tử để trả về kết quả thuộc tính. Sẽ có một FacetResult cho mọi tổ hợp sourceName/objectType/operatorName.
Biểu diễn dưới dạng JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Các trường | |
---|---|
sourceName |
Tên nguồn để thuộc tính bật. Định dạng: datasources/{sourceId} Nếu trống, tất cả nguồn dữ liệu sẽ được sử dụng. |
objectType |
Nếu bạn đặt objectType, thì chỉ những đối tượng thuộc loại đó mới được dùng để tính toán các thuộc tính. Nếu trống, tất cả đối tượng sẽ được dùng để tính toán các thuộc tính. |
operatorName |
Tên của toán tử được chọn để phân mặt. @xem cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
Số lượng nhóm thuộc tính tối đa sẽ được trả về cho thuộc tính này. Giá trị mặc định là 10. Giá trị tối đa là 100. |
integerFacetingOptions |
Nếu được đặt, mô tả các tuỳ chọn thuộc tính số nguyên cho thuộc tính số nguyên đã cho. Thuộc tính số nguyên tương ứng trong giản đồ cần được đánh dấu là isFacetable. Số lượng nhóm được trả về sẽ tối thiểu là số lượng này và numFacetBuckets. |
IntegerFacetingOptions
Dùng để chỉ định các tuỳ chọn thuộc tính số nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "integerBuckets": [ string ] } |
Các trường | |
---|---|
integerBuckets[] |
Nhóm cho các giá trị số nguyên đã cho nên theo thứ tự tăng dần. Ví dụ: nếu giá trị được cung cấp là (1,5,10,100), các nhóm thuộc tính sau sẽ được tạo thành {<1, [1,5), [5-10), [10-100), >=100}. |
QueryInterpretationConfig
Các tuỳ chọn mặc định để diễn giải truy vấn của người dùng.
Biểu diễn dưới dạng JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Các trường | |
---|---|
forceVerbatimMode |
Bật cờ này để tắt tất cả các tính năng tối ưu hoá nội bộ, chẳng hạn như diễn giải truy vấn bằng ngôn ngữ tự nhiên (NL), truy xuất kết quả bổ sung và sử dụng các từ đồng nghĩa bao gồm cả các từ tuỳ chỉnh. Nếu bạn đặt cờ này thành True, thì cờ này sẽ được ưu tiên hơn lựa chọn đặt ở cấp Truy vấn. Đối với giá trị mặc định là False, cờ cấp cụm từ tìm kiếm sẽ thiết lập cách diễn giải chính xác cho chế độ nguyên văn. |
forceDisableSupplementalResults |
Thiết lập cờ này để tắt tính năng truy xuất kết quả bổ sung. Việc đặt cờ tại đây sẽ không truy xuất các kết quả bổ sung cho các truy vấn được liên kết với một ứng dụng tìm kiếm nhất định. Nếu bạn đặt cờ này thành True, thì cờ này sẽ được ưu tiên hơn lựa chọn đặt ở cấp Truy vấn. Đối với giá trị mặc định là False, cờ ở cấp cụm từ tìm kiếm sẽ thiết lập cách diễn giải chính xác cho các kết quả bổ sung. |
Phương thức |
|
---|---|
|
Tạo ứng dụng tìm kiếm. |
|
Xoá ứng dụng tìm kiếm. |
|
Lấy ứng dụng tìm kiếm được chỉ định. |
|
Liệt kê tất cả các ứng dụng tìm kiếm. |
|
Cập nhật một ứng dụng tìm kiếm. |
|
Đặt lại ứng dụng tìm kiếm về cài đặt mặc định. |
|
Cập nhật một ứng dụng tìm kiếm. |