Class SearchRequest (0.51.0) 

public final class SearchRequest extends GeneratedMessageV3 implements SearchRequestOrBuilder

Request message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest

Static Fields

BOOST_SPEC_FIELD_NUMBER

public static final int BOOST_SPEC_FIELD_NUMBER
Field Value
Type Description
int

BRANCH_FIELD_NUMBER

public static final int BRANCH_FIELD_NUMBER
Field Value
Type Description
int

CANONICAL_FILTER_FIELD_NUMBER

public static final int CANONICAL_FILTER_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_SEARCH_SPEC_FIELD_NUMBER

public static final int CONTENT_SEARCH_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_SPECS_FIELD_NUMBER

public static final int DATA_STORE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FACET_SPECS_FIELD_NUMBER

public static final int FACET_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_QUERY_FIELD_NUMBER

public static final int IMAGE_QUERY_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER
Field Value
Type Description
int

ONE_BOX_PAGE_SIZE_FIELD_NUMBER

public static final int ONE_BOX_PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_EXPANSION_SPEC_FIELD_NUMBER

public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

SAFE_SEARCH_FIELD_NUMBER

public static final int SAFE_SEARCH_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_AS_YOU_TYPE_SPEC_FIELD_NUMBER

public static final int SEARCH_AS_YOU_TYPE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

SESSION_SPEC_FIELD_NUMBER

public static final int SESSION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

SPELL_CORRECTION_SPEC_FIELD_NUMBER

public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

USER_INFO_FIELD_NUMBER

public static final int USER_INFO_FIELD_NUMBER
Field Value
Type Description
int

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER
Field Value
Type Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest getDefaultInstance()
Returns
Type Description
SearchRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.Builder newBuilder()
Returns
Type Description
SearchRequest.Builder

newBuilder(SearchRequest prototype)

public static SearchRequest.Builder newBuilder(SearchRequest prototype)
Parameter
Name Description
prototype SearchRequest
Returns
Type Description
SearchRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest> parser()
Returns
Type Description
Parser<SearchRequest>

Methods

containsParams(String key)

public boolean containsParams(String key)

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. For example, user_country_code: "au"

    For available codes see Country Codes

  • 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. For example, search_type: 1

map<string, .google.protobuf.Value> params = 11;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsUserLabels(String key)

public boolean containsUserLabels(String key)

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 for more details.

map<string, string> user_labels = 22;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpecOrBuilder

getBranch()

public String getBranch()

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.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The branch.

getBranchBytes()

public ByteString getBranchBytes()

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.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for branch.

getCanonicalFilter()

public String getCanonicalFilter()

The default filter that is applied when a user performs a search without checking any filters on the search page.

The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

For more information about filter syntax, see SearchRequest.filter.

string canonical_filter = 29;

Returns
Type Description
String

The canonicalFilter.

getCanonicalFilterBytes()

public ByteString getCanonicalFilterBytes()

The default filter that is applied when a user performs a search without checking any filters on the search page.

The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

For more information about filter syntax, see SearchRequest.filter.

string canonical_filter = 29;

Returns
Type Description
ByteString

The bytes for canonicalFilter.

getContentSearchSpec()

public SearchRequest.ContentSearchSpec getContentSearchSpec()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type Description
SearchRequest.ContentSearchSpec

The contentSearchSpec.

getContentSearchSpecOrBuilder()

public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type Description
SearchRequest.ContentSearchSpecOrBuilder

getDataStoreSpecs(int index)

public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec

getDataStoreSpecsCount()

public int getDataStoreSpecsCount()

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Returns
Type Description
int

getDataStoreSpecsList()

public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpecOrBuilder

getDataStoreSpecsOrBuilderList()

public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpecOrBuilder>

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
Type Description
SearchRequest

getFacetSpecs(int index)

public SearchRequest.FacetSpec getFacetSpecs(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.FacetSpec

getFacetSpecsCount()

public int getFacetSpecsCount()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type Description
int

getFacetSpecsList()

public List<SearchRequest.FacetSpec> getFacetSpecsList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type Description
List<FacetSpec>

getFacetSpecsOrBuilder(int index)

public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.FacetSpecOrBuilder

getFacetSpecsOrBuilderList()

public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.FacetSpecOrBuilder>

getFilter()

public String getFilter()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

Returns
Type Description
ByteString

The bytes for filter.

getImageQuery()

public SearchRequest.ImageQuery getImageQuery()

Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

Returns
Type Description
SearchRequest.ImageQuery

The imageQuery.

getImageQueryOrBuilder()

public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()

Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

Returns
Type Description
SearchRequest.ImageQueryOrBuilder

getLanguageCode()

public String getLanguageCode()

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.

string language_code = 35;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.

string language_code = 35;

Returns
Type Description
ByteString

The bytes for languageCode.

getOffset()

public int getOffset()

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.

int32 offset = 6;

Returns
Type Description
int

The offset.

getOneBoxPageSize()

public int getOneBoxPageSize()

The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.

int32 one_box_page_size = 47;

Returns
Type Description
int

The oneBoxPageSize.

getOrderBy()

public String getOrderBy()

The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive.

For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive.

For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.

  • Websites with basic indexing: Default 10, Maximum 25.
  • Websites with advanced indexing: Default 25, Maximum 50.

  • Other: Default 50, Maximum 100.

    If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 4;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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.

string page_token = 5;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 5;

Returns
Type Description
ByteString

The bytes for pageToken.

getParams() (deprecated)

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
Type Description
Map<String,Value>

getParamsCount()

public int getParamsCount()

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. For example, user_country_code: "au"

    For available codes see Country Codes

  • 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. For example, search_type: 1

map<string, .google.protobuf.Value> params = 11;

Returns
Type Description
int

getParamsMap()

public Map<String,Value> getParamsMap()

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. For example, user_country_code: "au"

    For available codes see Country Codes

  • 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. For example, search_type: 1

map<string, .google.protobuf.Value> params = 11;

Returns
Type Description
Map<String,Value>

getParamsOrDefault(String key, Value defaultValue)

public Value getParamsOrDefault(String key, Value defaultValue)

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. For example, user_country_code: "au"

    For available codes see Country Codes

  • 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. For example, search_type: 1

map<string, .google.protobuf.Value> params = 11;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getParamsOrThrow(String key)

public Value getParamsOrThrow(String key)

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. For example, user_country_code: "au"

    For available codes see Country Codes

  • 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. For example, search_type: 1

map<string, .google.protobuf.Value> params = 11;

Parameter
Name Description
key String
Returns
Type Description
Value

getParserForType()

public Parser<SearchRequest> getParserForType()
Returns
Type Description
Parser<SearchRequest>
Overrides

getQuery()

public String getQuery()

Raw search query.

string query = 3;

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Raw search query.

string query = 3;

Returns
Type Description
ByteString

The bytes for query.

getQueryExpansionSpec()

public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type Description
SearchRequest.QueryExpansionSpec

The queryExpansionSpec.

getQueryExpansionSpecOrBuilder()

public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type Description
SearchRequest.QueryExpansionSpecOrBuilder

getSafeSearch()

public boolean getSafeSearch()

Whether to turn on safe search. This is only supported for website search.

bool safe_search = 20;

Returns
Type Description
boolean

The safeSearch.

getSearchAsYouTypeSpec()

public SearchRequest.SearchAsYouTypeSpec getSearchAsYouTypeSpec()

Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

Returns
Type Description
SearchRequest.SearchAsYouTypeSpec

The searchAsYouTypeSpec.

getSearchAsYouTypeSpecOrBuilder()

public SearchRequest.SearchAsYouTypeSpecOrBuilder getSearchAsYouTypeSpecOrBuilder()

Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

Returns
Type Description
SearchRequest.SearchAsYouTypeSpecOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServingConfig()

public String getServingConfig()

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or 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.

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or 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.

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for servingConfig.

getSession()

public String getSession()

The session resource name. Optional.

Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.

Example #1 (multi-turn /search API calls):

  1. Call /search API with the auto-session mode (see below).

  2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".

    Example #2 (coordination between /search API calls and /answer API calls):

  3. Call /search API with the auto-session mode (see below).

  4. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.

    Auto-session mode: when projects/.../sessions/- is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.

    Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

The session resource name. Optional.

Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.

Example #1 (multi-turn /search API calls):

  1. Call /search API with the auto-session mode (see below).

  2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".

    Example #2 (coordination between /search API calls and /answer API calls):

  3. Call /search API with the auto-session mode (see below).

  4. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.

    Auto-session mode: when projects/.../sessions/- is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.

    Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

getSessionSpec()

public SearchRequest.SessionSpec getSessionSpec()

Session specification.

Can be used only when session is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

Returns
Type Description
SearchRequest.SessionSpec

The sessionSpec.

getSessionSpecOrBuilder()

public SearchRequest.SessionSpecOrBuilder getSessionSpecOrBuilder()

Session specification.

Can be used only when session is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

Returns
Type Description
SearchRequest.SessionSpecOrBuilder

getSpellCorrectionSpec()

public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type Description
SearchRequest.SpellCorrectionSpec

The spellCorrectionSpec.

getSpellCorrectionSpecOrBuilder()

public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type Description
SearchRequest.SpellCorrectionSpecOrBuilder

getUserInfo()

public UserInfo getUserInfo()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Returns
Type Description
UserInfo

The userInfo.

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Returns
Type Description
UserInfoOrBuilder

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

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 for more details.

map<string, string> user_labels = 22;

Returns
Type Description
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

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 for more details.

map<string, string> user_labels = 22;

Returns
Type Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

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 for more details.

map<string, string> user_labels = 22;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

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 for more details.

map<string, string> user_labels = 22;

Parameter
Name Description
key String
Returns
Type Description
String

getUserPseudoId()

public String getUserPseudoId()

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.

string user_pseudo_id = 15;

Returns
Type Description
String

The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

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.

string user_pseudo_id = 15;

Returns
Type Description
ByteString

The bytes for userPseudoId.

hasBoostSpec()

public boolean hasBoostSpec()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
boolean

Whether the boostSpec field is set.

hasContentSearchSpec()

public boolean hasContentSearchSpec()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type Description
boolean

Whether the contentSearchSpec field is set.

hasImageQuery()

public boolean hasImageQuery()

Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

Returns
Type Description
boolean

Whether the imageQuery field is set.

hasQueryExpansionSpec()

public boolean hasQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type Description
boolean

Whether the queryExpansionSpec field is set.

hasSearchAsYouTypeSpec()

public boolean hasSearchAsYouTypeSpec()

Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

Returns
Type Description
boolean

Whether the searchAsYouTypeSpec field is set.

hasSessionSpec()

public boolean hasSessionSpec()

Session specification.

Can be used only when session is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

Returns
Type Description
boolean

Whether the sessionSpec field is set.

hasSpellCorrectionSpec()

public boolean hasSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type Description
boolean

Whether the spellCorrectionSpec field is set.

hasUserInfo()

public boolean hasUserInfo()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Returns
Type Description
boolean

Whether the userInfo field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.Builder newBuilderForType()
Returns
Type Description
SearchRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.Builder toBuilder()
Returns
Type Description
SearchRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException