Web Search API, gRPC: WebSearchService.Search

Статья создана

Обновлена 17 декабря 2024 г.

gRPC request
WebSearchRequest
SearchQuery
SortSpec
GroupSpec
WebSearchResponse

gRPC request

rpc Search (WebSearchRequest) returns (WebSearchResponse)

WebSearchRequest

{
  "query": {
    "search_type": "SearchType",
    "query_text": "string",
    "family_mode": "FamilyMode",
    "page": "int64",
    "fix_typo_mode": "FixTypoMode"
  },
  "sort_spec": {
    "sort_mode": "SortMode",
    "sort_order": "SortOrder"
  },
  "group_spec": {
    "group_mode": "GroupMode",
    "groups_on_page": "int64",
    "docs_in_group": "int64"
  },
  "max_passages": "int64",
  "region": "string",
  "l10n": "Localization",
  "folder_id": "string",
  "response_format": "Format",
  "user_agent": "string"
}

Field	Description
query	SearchQuery Required field. Search query.
sort_spec	SortSpec The rules for sorting search results that define the sequence of the returned search results.
group_spec	GroupSpec Grouping settings that are used to group documents from a single domain into a container.
max_passages	int64 The maximum number of passages that can be used when generating a document snippet.
region	string ID of the search country or region that impacts the document ranking rules.
l10n	enum Localization The notification language for a search response. `LOCALIZATION_UNSPECIFIED` `LOCALIZATION_RU`: Russian (default value) `LOCALIZATION_UK`: Ukrainian `LOCALIZATION_BE`: Belarusian `LOCALIZATION_KK`: Kazakh `LOCALIZATION_TR`: Turkish `LOCALIZATION_EN`: English
folder_id	string ID of the folder.
response_format	enum Format Search results format. `FORMAT_UNSPECIFIED` `FORMAT_XML`: XML format (default value) `FORMAT_HTML`: HTML format
user_agent	string User-Agent request header value.

SearchQuery

Field	Description
search_type	enum SearchType Required field. Search type that determines the domain name that will be used for the search queries. `SEARCH_TYPE_UNSPECIFIED` `SEARCH_TYPE_RU`: Russian search type (default), yandex.ru search domain name will be used. `SEARCH_TYPE_TR`: Turkish search type, yandex.tr search domain name will be used. `SEARCH_TYPE_COM`: International search type, yandex.com search domain name will be used.
query_text	string Required field. Search query text
family_mode	enum FamilyMode Rule for filtering search results and determines whether any documents should be excluded. `FAMILY_MODE_UNSPECIFIED` `FAMILY_MODE_NONE`: Filtering is disabled. Search results include any documents regardless of their contents. `FAMILY_MODE_MODERATE`: Moderate filter (default value). Documents of the Adult category are excluded from search results unless a query is explicitly made for searching resources of this category. `FAMILY_MODE_STRICT`: Regardless of a search query, documents of the Adult category and those with profanity are excluded from search results.
page	int64 The number of a requested page with search results
fix_typo_mode	enum FixTypoMode Typos autocorrections mode `FIX_TYPO_MODE_UNSPECIFIED` `FIX_TYPO_MODE_ON`: Automatically correct typos (default value). `FIX_TYPO_MODE_OFF`: Autocorrection is off.

SortSpec

Field

Description

sort_mode

enum SortMode

Documents sorting mode.

SORT_MODE_UNSPECIFIED
SORT_MODE_BY_RELEVANCE: Sort documents by relevance (default value).
SORT_MODE_BY_TIME: Sort documents by update time.

sort_order

enum SortOrder

Documents sorting order.

SORT_ORDER_UNSPECIFIED
SORT_ORDER_ASC: Reverse order from oldest to most recent.
SORT_ORDER_DESC: Direct order from most recent to oldest (default).

GroupSpec

Field	Description
group_mode	enum GroupMode Grouping method. `GROUP_MODE_UNSPECIFIED` `GROUP_MODE_FLAT`: Flat grouping. Each group contains a single document. `GROUP_MODE_DEEP`: Grouping by domain. Each group contains documents from one domain.
groups_on_page	int64 Maximum number of groups that can be returned per page with search results.
docs_in_group	int64 Maximum number of documents that can be returned per group.

WebSearchResponse

{
  "raw_data": "bytes"
}

Field

Description

raw_data

bytes

Required field. Search results, either in XML or HTML format depending on the request settings.

Web Search API, gRPC: WebSearchService.Search

gRPC requestgRPC request

WebSearchRequestWebSearchRequest

SearchQuerySearchQuery

SortSpecSortSpec

GroupSpecGroupSpec

WebSearchResponseWebSearchResponse