Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Web Search API, gRPC: WebSearchAsyncService.Search

Written by
Updated at October 17, 2024

gRPC request

rpc Search (WebSearchRequest) returns (operation.Operation)

WebSearchRequest

{
  "query": {
    "searchType": "SearchType",
    "queryText": "string",
    "familyMode": "FamilyMode",
    "page": "int64"
  },
  "sortSpec": {
    "sortMode": "SortMode",
    "sortOrder": "SortOrder"
  },
  "groupSpec": {
    "groupMode": "GroupMode",
    "groupsOnPage": "int64",
    "docsInGroup": "int64"
  },
  "maxPassages": "int64",
  "region": "string",
  "l10n": "Localization",
  "folderId": "string"
}

Field

Description

query

SearchQuery

Required field. Search query.

sortSpec

SortSpec

The rules for sorting search results that define the sequence of the returned search results.

groupSpec

GroupSpec

Grouping settings that are used to group documents from a single domain into a container.

maxPassages

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

folderId

string

ID of the folder.

SearchQuery

Field

Description

searchType

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.

queryText

string

Required field. Search query text

familyMode

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

SortSpec

Field

Description

sortMode

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.

sortOrder

enum SortOrder

Documents sorting order.

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

GroupSpec

Field

Description

groupMode

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.

groupsOnPage

int64

Maximum number of groups that can be returned per page with search results.

docsInGroup

int64

Maximum number of documents that can be returned per group.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "rawData": "bytes"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

WebSearchResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

WebSearchResponse

Field

Description

rawData

bytes

Required field. Search results, usually in XML format.
Previous
Overview
Next
Overview