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: ứng dụng tìm kiếm/{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 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 dataSourceConstraint.

scoringConfig

object (ScoringConfig)

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

defaultSortOptions

object (SortOptions)

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ả thuộc tính. 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 nên 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 Hoạt động chạy trong thời gian dài (LRO) hiện đang chạy cho giản đồ này. Trường chỉ có đầu ra.

enableAuditLog

boolean

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 thực hiện cho ứng dụng tìm kiếm trong API truy vấn hay không.

queryInterpretationConfig

object (QueryInterpretationConfig)

Các lựa chọn mặc định để diễn giải cụm từ tìm kiếm

DataSourceRestriction

Quy định hạn chế về 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 quy định hạn chế.

filterOptions[]

object (FilterOptions)

Tuỳ chọn bộ lọc hạn chế kết quả. Nếu có nhiều bộ lọc, thì 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 theo cách kết hợp, sau đó các biểu thức thu được sẽ được kết hợp không hợp lệ.

Số lượng phần tử tối đa là 20.

LƯU Ý: API Đề xuất hiện chỉ hỗ trợ một số bộ lọc: "objecttype", "type" và "mimetype". Hiện tại, không thể sử dụng các bộ lọc cụ thể của giản đồ để lọc đề xuất.

Nguồn

Xác định các nguồn cho 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 kết hợp source.

source chỉ có thể là một trong những trạng thái sau đây:

name

string

Tên nguồn cho nội dung được 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 những cụm từ tìm kiếm mà người dùng từng đưa ra. Chỉ hợp lệ khi được sử dụng cùng với API đề xuất. Bị bỏ qua khi được sử dụng trong API truy vấn.
PERSON Đề xuất thành viên trong tổ chức. Chỉ hợp lệ khi được sử dụng cù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 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 (Filter)
  }
}
Trường
objectType

string

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

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

Cách chung thể hiện bộ lọc trong truy vấn, hỗ trợ hai cách tiếp cận:

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

2. Đặt CompositeFilter. Các bộ lọc được đánh giá bằng toán tử logic. Các 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. HOẶC chỉ có thể xuất hiện dưới cấp cao nhất AND.

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 kết hợp filter.

filter chỉ có thể là một trong những trạng thái sau đây:

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 có thể hoạt động dựa trên 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 đồ của bạn. Truy vấn lọc kết quả để tìm những 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 về một giá trị duy nhất cùng 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 kết hợp 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

string

integerValue

string (int64 format)

doubleValue

number

timestampValue

string (Timestamp format)

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""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 Các toán tử logic, chỉ có thể áp dụng cho các bộ lọc phụ.
OR
NOT KHÔNG chỉ có thể áp dụ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 mà cấu hình này sẽ được sử dụng.

scoringConfig

object (SourceScoringConfig)

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

crowdingConfig

object (SourceCrowdingConfig)

Cấu hình chèn lấn 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 (SourceScoringConfig.SourceImportance)
}
Trường
sourceImportance

enum (SourceScoringConfig.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ể dùng để cho biết liệu một nguồn có nên được ưu tiên hơn trong thứ hạng so với một nguồn khác hay không.

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Đặt giới hạn chồng chéo kết quả tìm kiếm. Hiện tượng chèn lấn là trường hợp nhiều kết quả từ cùng một nguồn hoặc máy chủ lưu trữ "xuất hiện quá nhiều kết quả" 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. Để cải thiện 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 điều kiện để giảm các 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ố 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 không bị cạn. 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 chèn lấn, 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. 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

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ới 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. 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)

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 (IntegerFacetingOptions)
  }
}
Trường
sourceName

string

Tên nguồn thuộc tính. Định dạng: datasources/{sourceId} Nếu trống, hệ thống sẽ sử dụng tất cả nguồn dữ liệu.

objectType

string

Nếu bạn đặt objectType, chỉ các đố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

string

Tên của toán tử được chọn để phân lớp. @xem Cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

Số nhóm thuộc tính tối đa cần đượ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

object (IntegerFacetingOptions)

Nếu đặ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 đồ phải được đánh dấu là isFacetable. Số lượng nhóm được trả về sẽ ở mức tối thiểu là số này và numFacetBuckets.

IntegerFacetingOptions

Dùng để chỉ định các tuỳ chọn liên kết 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 theo thứ tự tăng dần nghiêm ngặt. Ví dụ: nếu các 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
}
Trường
forceVerbatimMode

boolean

Bật cờ này để tắt tất cả các tối ưu hóa nội bộ 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 từ đồng nghĩa bao gồm từ đồng nghĩa tùy chỉnh. Nếu bạn đặt cờ này thành True, thì cờ này sẽ được ưu tiên hơn so với tuỳ chọn được đặt ở cấp Cụm từ tìm kiếm. Đối với giá trị mặc định là False, cờ cấp truy vấn sẽ thiết lập cách diễn giải chính xác cho chế độ nguyên văn.

forceDisableSupplementalResults

boolean

Đặt cờ này để vô hiệu hoá truy xuất kết quả bổ sung, việc đặt cờ ở đây sẽ không truy xuất 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 so với tuỳ chọn được đặt ở cấp Cụm từ tìm kiếm. Đối với giá trị mặc định là False, cờ cấp truy vấn sẽ thiết lập cách diễn giải chính xác cho kết quả bổ sung.

Phương thức

create

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

delete

Xoá ứ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 một ứng dụng tìm kiếm.

reset

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

update

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