Class SearchRequest (0.8.1)

SearchRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for SearchService.Search method.

Attributes
Name	Description
`serving_config`	`str` Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
`branch`	`str` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
`query`	`str` Raw search query.
`page_size`	`int` Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
`page_token`	`str` A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
`offset`	`int` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
`user_info`	`google.cloud.discoveryengine_v1.types.UserInfo` Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.
`params`	`MutableMapping[str, google.protobuf.struct_pb2.Value]` Additional search parameters. For public website search only, supported values are: - `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. - `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
`query_expansion_spec`	`google.cloud.discoveryengine_v1.types.SearchRequest.QueryExpansionSpec` The query expansion specification that specifies the conditions under which query expansion will occur.
`spell_correction_spec`	`google.cloud.discoveryengine_v1.types.SearchRequest.SpellCorrectionSpec` The spell correction specification that specifies the mode under which spell correction will take effect.
`user_pseudo_id`	`str` A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
`content_search_spec`	`google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec` The content search spec that configs the desired behavior of content search.
`safe_search`	`bool` Whether to turn on safe search. This is only supported for [ContentConfig.PUBLIC_WEBSITE][].
`user_labels`	`MutableMapping[str, str]` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See `Google Cloud Document

Classes

ContentSearchSpec

ContentSearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specification that configs the desired behavior of the UCS content search.

ParamsEntry

ParamsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

QueryExpansionSpec

QueryExpansionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specification to determine under which conditions query expansion should occur.

SpellCorrectionSpec

SpellCorrectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specification for query spell correction.

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)