REST Resource: settings.searchapplications

Tài nguyên: SearchApplication

SearchApplication

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Trường
name

string

Tên của Ứng dụng tìm kiếm.

Định dạng: searchapplications/{applicationId}.
displayName

string

Tên hiển thị của Ứng dụng tìm kiếm. Độ dài tối đa là 300 ký tự.
dataSourceRestrictions[]

object (DataSourceRestriction)

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[]

object (SourceConfig)

Cấu hình cho một nguồn được chỉ định trong dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Cấu hình cho kết quả xếp hạng.
defaultSortOptions

object (SortOptions)

Các tuỳ chọn mặc định để sắp xếp kết quả tìm kiếm
defaultFacetOptions[]

object (FacetOptions)

Các trường mặc định để trả về kết quả theo phương diện. Các nguồn được chỉ định ở đây cũng đã được đưa vào dataSourceRestrictions ở trên.
returnResultThumbnailUrls

boolean

Với mỗi kết quả, chúng ta sẽ trả về URI cho hình thu nhỏ của kết quả đó (nếu có)
operationIds[]

string

Chỉ có đầu ra. Mã của các Thao tác thực hiện lâu (LRO) hiện đang chạy cho giản đồ này. Trường chỉ có đầu ra.
enableAuditLog

boolean

Cho biết tính năng ghi nhật ký kiểm tra đang bật/tắt cho các yêu cầu được thực hiện cho ứng dụng tìm kiếm trong API truy vấn.
queryInterpretationConfig

object (QueryInterpretationConfig)

Các tuỳ chọn mặc định để diễn giải truy vấn

DataSourceRestriction

Quy định hạn chế đối với Nguồn dữ liệu.

Biểu diễn dưới dạng JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Trường
source

object (Source)

Nguồn của lệnh hạn chế.
filterOptions[]

object (FilterOptions)

Các 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 đó 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 với nhau, sau đó biểu thức thu được được kết hợp với nhau theo kiểu loại trừ.

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 số bộ lọc: "objecttype", "type" và "mimetype". Hiện tại, bạn không thể sử dụng bộ lọc dành riêng cho giản đồ để lọc nội dung đề 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 source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Trường

Trường hợp hợp nhất source.

source chỉ có thể là một trong những loại sau:
name

string

Tên nguồn cho nội dung do Indexing API lập chỉ mục.
predefinedSource

enum (Source.PredefinedSource)

Nguồn nội dung được xác định trước cho Google Apps.

Source.PredefinedSource

Nguồn được xác định trước:

Enum
NONE
QUERY_HISTORY Đề xuất các cụm từ tìm kiếm mà 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 được sử dụng trong API truy vấn.
PERSON Đề xuất những người trong tổ chức. Chỉ hợp lệ khi được sử dụng với API đề xuất. Dẫn đến lỗi khi sử dụng trong API truy vấn.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Các tuỳ chọn bộ lọc sẽ được áp dụng cho truy vấn.

Biểu diễn dưới dạng JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Trường
objectType

string

Nếu bạn đặt objectType, thì chỉ những đố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

object (Filter)

Bộ lọc chung để hạn chế nội dung tìm kiếm, chẳng hạn như lang:en, site:xyz.

Lọc

Một cách chung để biểu thị bộ lọc trong truy vấn, hỗ trợ hai phương pháp:

1. Đặt ValueFilter. Tên này phải khớp với operatorName được xác định trong giản đồ cho nguồn dữ liệu của bạn.

2. Thiết lập CompositeFilter. Các bộ lọc đượ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. Toán tử AND chỉ có thể xuất hiện ở cấp cao nhất. Toán tử HOẶC chỉ có thể xuất hiện trong toán tử AND cấp cao nhất.

Biểu diễn dưới dạng JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Trường

Trường hợp hợp nhất filter.

filter chỉ có thể là một trong những loại sau:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Trường
operatorName

string

operatorName áp dụng cho truy vấn, chẳng hạn như price_greater_than. Bộ lọc này có thể hoạt động với cả hai loại bộ lọc được xác định trong giản đồ cho nguồn dữ liệu của bạn:

  1. operatorName, trong đó truy vấn lọc kết quả theo thuộc tính khớp với giá trị.

  2. greaterThanOperatorName hoặc lessThanOperatorName trong giản đồ. Truy vấn này lọc kết quả cho các giá trị thuộc tính lớn hơn hoặc nhỏ hơn giá trị được cung cấp trong truy vấn.
value

object (Value)

Giá trị cần so sánh.

Giá trị

Định nghĩa một giá trị duy nhất có loại chung.

Biểu diễn dưới dạng JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Trường
Trường hợp hợp nhất value. Giá trị của thuộc tính được đặt tên. value chỉ có thể là một trong những loại sau:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Biểu diễn dưới dạng JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Trường
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Toán tử logic của bộ lọc phụ.
subFilters[]

object (Filter)

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 Bạn chỉ có thể áp dụng toán tử KHÔNG cho 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 (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Trường
source

object (Source)

Nguồn sẽ sử dụng cấu hình này.
scoringConfig

object (SourceScoringConfig)

Cấu hình tính điểm cho nguồn.
crowdingConfig

object (SourceCrowdingConfig)

Cấu hình làm rối 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 (SourceScoringConfig.SourceImportance)
}
Trường
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Tầm quan trọng của nguồn.

SourceScoringConfig.SourceImportance

Mức độ quan trọng của một nguồn có thể được dùng để cho biết liệu một nguồn có đượ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

Đặt giới hạn nhóm kết quả tìm kiếm. Tình trạng lộn xộn là khi nhiều kết quả từ cùng một nguồn hoặc máy chủ lưu trữ "lấn át" các kết quả khác, làm giảm chất lượng kết quả tìm kiếm cho người dùng. Để cải thiện chất lượng tìm kiếm và sự đa dạng về nguồn trong kết quả tìm kiếm, bạn có thể đặt điều kiện để giảm kết quả trùng lặp theo nguồn.

Biểu diễn dưới dạng JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
Trường
numResults

integer

Số kết quả tối đa được phép từ một nguồn dữ liệu trong 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 âm. Hệ thống sẽ sử dụng giá trị mặc định 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

integer

Số lượng đề xuất tối đa được phép từ một nguồn. Hệ thống sẽ không đặt giới hạn cho kết quả nếu giá trị này nhỏ hơn hoặc bằng 0.

ScoringConfig

Cấu hình tính điểm 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
}
Trường
disableFreshness

boolean

Liệu có sử dụng mức độ mới mẻ làm tín hiệu xếp hạng hay không. Theo mặc định, độ mới được 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 quản trị.
disablePersonalization

boolean

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 (SortOptions.SortOrder)
}
Trường
operatorName

string

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à sortable.
sortOrder

enum (SortOptions.SortOrder)

Thứ tự tăng dần là thứ tự sắp xếp mặc định

SortOptions.SortOrder

Enum
ASCENDING
DESCENDING

FacetOptions

Chỉ định toán tử để trả về kết quả cho phương diện. 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 (IntegerFacetingOptions)
  }
}
Trường
sourceName

string

Tên nguồn để phân tích theo phương diện. Định dạng: datasources/{sourceId} Nếu để trống, tất cả nguồn dữ liệu sẽ được sử dụng.
objectType

string

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 mặt. Nếu trống, tất cả các đối tượng sẽ được dùng để tính toán các phương diện.
operatorName

string

Tên của toán tử được chọn để phân tách. @xem cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Số lượng bộ chứa phương diện tối đa sẽ được trả về cho phương diện này. Giá trị mặc định là 10. Giá trị tối đa là 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Nếu được đặt, mô tả các tuỳ chọn phân tích theo phương diện 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 đồ phải được đánh dấu là isFacetable. Số lượng bộ chứa được trả về sẽ là số lượng tối thiểu của giá trị này và numFacetBuckets.

IntegerFacetingOptions

Dùng để chỉ định các tuỳ chọn phân tích theo phương diện số nguyên.

Biểu diễn dưới dạng JSON 
{
  "integerBuckets": [
    string
  ]
}
Trường
integerBuckets[]

string (Int64Value format)

Các bộ chứa cho các giá trị số nguyên đã cho phải được sắp xếp theo thứ tự tăng dần một cách nghiêm ngặt. Ví dụ: nếu các giá trị được cung cấp là (1,5,10,100), thì các nhóm phương diện sau đây sẽ được tạo {<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
}
Trường
forceVerbatimMode

boolean

Bật cờ này để tắt tất cả các tính năng tối ưu hoá nội bộ như diễn giải cụm từ tìm kiếm bằng ngôn ngữ tự nhiên (NL), truy xuất kết quả bổ sung và sử dụng từ đồng nghĩa, bao gồm cả từ đồng nghĩa 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 tùy chọn được đặt ở cấp Truy vấn. Đối với giá trị mặc định là False, cờ cấp truy vấn sẽ đặt cách diễn giải chính xác cho chế độ nguyên văn.
forceDisableSupplementalResults

boolean

Đặt 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 kết quả bổ sung cho các cụm từ tìm kiếm 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 tùy chọn được đặt ở cấp Truy vấn. Đối với giá trị mặc định là False, cờ cấp truy vấn sẽ đặt cách diễn giải chính xác cho kết quả bổ sung.

Phương thức

create

 Tạo ứng dụng tìm kiếm.

delete

 Xoá một ứng dụng tìm kiếm.

get

 Lấy ứng dụng tìm kiếm đã chỉ định.

list

 Liệt kê tất cả ứng dụng tìm kiếm.

patch

 Cập nhật ứng dụng tìm kiếm.

reset

 Đặt lại ứng dụng tìm kiếm về chế độ cài đặt mặc định.

update

 Cập nhật ứng dụng tìm kiếm.