Interface SearchRequestOrBuilder (0.28.0)

public interface SearchRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsParams(String key)

public abstract 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. 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. Example: search_type: 1

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsUserLabels(String key)

public abstract 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`

getBoostSpec()

public abstract SearchRequest.BoostSpec getBoostSpec()

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

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

Returns
Type	Description
`SearchRequest.BoostSpec`	The boostSpec.

getBoostSpecOrBuilder()

public abstract SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

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

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

Returns
Type	Description
`SearchRequest.BoostSpecOrBuilder`

getBranch()

public abstract 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 abstract 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.

getContentSearchSpec()

public abstract SearchRequest.ContentSearchSpec getContentSearchSpec()

A specification for configuring the behavior of content search.

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

Returns
Type	Description
`SearchRequest.ContentSearchSpec`	The contentSearchSpec.

getContentSearchSpecOrBuilder()

public abstract SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()

A specification for configuring the behavior of content search.

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

Returns
Type	Description
`SearchRequest.ContentSearchSpecOrBuilder`

getEmbeddingSpec()

public abstract SearchRequest.EmbeddingSpec getEmbeddingSpec()

Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document embedding that is provided in [SearchRequest.embedding_spec.embedding_vectors.field_path][].

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.EmbeddingSpec`	The embeddingSpec.

getEmbeddingSpecOrBuilder()

public abstract SearchRequest.EmbeddingSpecOrBuilder getEmbeddingSpecOrBuilder()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.EmbeddingSpecOrBuilder`

getFacetSpecs(int index)

public abstract 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.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec`

getFacetSpecsCount()

public abstract 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.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`int`

getFacetSpecsList()

public abstract 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.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`List<FacetSpec>`

getFacetSpecsOrBuilder(int index)

public abstract 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.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpecOrBuilder`

getFacetSpecsOrBuilderList()

public abstract 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.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

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

getFilter()

public abstract 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 abstract 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.

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 abstract SearchRequest.ImageQuery getImageQuery()

Raw image query.

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

Returns
Type	Description
`SearchRequest.ImageQuery`	The imageQuery.

getImageQueryOrBuilder()

public abstract SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()

Raw image query.

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

Returns
Type	Description
`SearchRequest.ImageQueryOrBuilder`

getOffset()

public abstract 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.

getOrderBy()

public abstract 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, see Ordering

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

Values above 100 are coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 4;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract 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 abstract 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 abstract Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
Type	Description
`Map<String,Value>`

getParamsCount()

public abstract 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. 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. Example: search_type: 1

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

Returns
Type	Description
`int`

getParamsMap()

public abstract 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. 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. Example: search_type: 1

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

Returns
Type	Description
`Map<String,Value>`

getParamsOrDefault(String key, Value defaultValue)

public abstract 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. 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. 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 abstract 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. 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. Example: search_type: 1

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`

getQuery()

public abstract String getQuery()

Raw search query.

string query = 3;

Returns
Type	Description
`String`	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Raw search query.

string query = 3;

Returns
Type	Description
`ByteString`	The bytes for query.

getQueryExpansionSpec()

public abstract SearchRequest.QueryExpansionSpec getQueryExpansionSpec()

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

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

Returns
Type	Description
`SearchRequest.QueryExpansionSpec`	The queryExpansionSpec.

getQueryExpansionSpecOrBuilder()

public abstract SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()

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

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

Returns
Type	Description
`SearchRequest.QueryExpansionSpecOrBuilder`

getRankingExpression()

public abstract String getRankingExpression()

The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by "+".

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Returns
Type	Description
`String`	The rankingExpression.

getRankingExpressionBytes()

public abstract ByteString getRankingExpressionBytes()

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Returns
Type	Description
`ByteString`	The bytes for rankingExpression.

getSafeSearch()

public abstract 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.

getServingConfig()

public abstract 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 abstract ByteString getServingConfigBytes()

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

Returns
Type	Description
`ByteString`	The bytes for servingConfig.

getSpellCorrectionSpec()

public abstract SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()

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

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

Returns
Type	Description
`SearchRequest.SpellCorrectionSpec`	The spellCorrectionSpec.

getSpellCorrectionSpecOrBuilder()

public abstract SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()

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

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

Returns
Type	Description
`SearchRequest.SpellCorrectionSpecOrBuilder`

getUserInfo()

public abstract 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.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`UserInfo`	The userInfo.

getUserInfoOrBuilder()

public abstract 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.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`UserInfoOrBuilder`

getUserLabels() (deprecated)

public abstract Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getUserLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getUserPseudoIdBytes()

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 abstract boolean hasBoostSpec()

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

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

Returns
Type	Description
`boolean`	Whether the boostSpec field is set.

hasContentSearchSpec()

public abstract boolean hasContentSearchSpec()

A specification for configuring the behavior of content search.

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

Returns
Type	Description
`boolean`	Whether the contentSearchSpec field is set.

hasEmbeddingSpec()

public abstract boolean hasEmbeddingSpec()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`boolean`	Whether the embeddingSpec field is set.

hasImageQuery()

public abstract boolean hasImageQuery()

Raw image query.

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

Returns
Type	Description
`boolean`	Whether the imageQuery field is set.

hasQueryExpansionSpec()

public abstract boolean hasQueryExpansionSpec()

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

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

Returns
Type	Description
`boolean`	Whether the queryExpansionSpec field is set.

hasSpellCorrectionSpec()

public abstract boolean hasSpellCorrectionSpec()

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

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

Returns
Type	Description
`boolean`	Whether the spellCorrectionSpec field is set.

hasUserInfo()

public abstract 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.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`boolean`	Whether the userInfo field is set.