Method: query.suggest

Cung cấp đề xuất để tự động hoàn thành truy vấn.

Lưu ý: API này yêu cầu tài khoản người dùng cuối tiêu chuẩn để thực thi. Tài khoản dịch vụ không thể trực tiếp thực hiện các yêu cầu API Truy vấn. Để sử dụng tài khoản dịch vụ để thực hiện truy vấn, hãy thiết lập tính năng uỷ quyền trên toàn miền của Google Workspace.

Yêu cầu HTTP

POST https://cloudsearch.googleapis.com/v1/query/suggest

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Các trường
requestOptions

object (RequestOptions)

Tuỳ chọn yêu cầu, chẳng hạn như ứng dụng tìm kiếm và múi giờ của người dùng.

query

string

Một phần truy vấn cho các đề xuất tự động hoàn thành sẽ được hiển thị. Ví dụ: nếu cụm từ tìm kiếm là "sea" thì máy chủ có thể trả về "season", "search", "seagull", v.v.

dataSourceRestrictions[]

object (DataSourceRestriction)

Các nguồn để sử dụng cho đề xuất. Nếu bạn không chỉ định, nguồn dữ liệu sẽ được lấy từ ứng dụng tìm kiếm hiện tại.

LƯU Ý: Đề xuất chỉ được hỗ trợ cho các nguồn sau:

  • Nguồn dữ liệu của bên thứ ba
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Phản hồi của API đề xuất.

Biểu diễn dưới dạng JSON
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Các trường
suggestResults[]

object (SuggestResult)

Danh sách đề xuất.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

SuggestResult

Một kết quả đề xuất.

Biểu diễn dưới dạng JSON
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
Các trường
suggestedQuery

string

Cụm từ tìm kiếm đề xuất sẽ được dùng khi người dùng nhấp vào cụm từ tìm kiếm.

source

object (Source)

Nguồn của đề xuất.

Trường nhóm suggestion. Chứa siêu dữ liệu bổ sung về truy vấn được đề xuất. Trường này cũng cho biết loại truy vấn được đề xuất. Ví dụ: nếu có đề xuất Người dùng, thì tức là đề xuất_query là một đề xuất người dùng. suggestion chỉ có thể là một trong những trạng thái sau đây:
querySuggestion

object (QuerySuggestion)

Trường này sẽ xuất hiện nếu truy vấn đề xuất là một từ/cụm từ hoàn tất.

peopleSuggestion

object (PeopleSuggestion)

Tính năng này xuất hiện khi cụm từ đề xuất chỉ ra một người. Bảng này chứa thêm thông tin về người đó, chẳng hạn như mã email, tên, v.v.

QuerySuggestion

Hiện tại, trường này không chứa bất kỳ thông tin nào và chỉ được dùng làm chỉ báo cho biết kết quả đề xuất là một cụm từ hoàn chỉnh.

PeopleSuggestion

Trường này chứa thông tin về người được đề xuất.

Biểu diễn dưới dạng JSON
{
  "person": {
    object (Person)
  }
}
Các trường
person

object (Person)

Người được đề xuất. Tất cả các trường của đối tượng người này có thể không được điền sẵn.