Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest.
Request message for SearchService.Search method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#boost_spec
def boost_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec) — Boost specification to boost certain documents. For more information on boosting, see Boosting
#boost_spec=
def boost_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec) — Boost specification to boost certain documents. For more information on boosting, see Boosting
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec) — Boost specification to boost certain documents. For more information on boosting, see Boosting
#branch
def branch() -> ::String
-
(::String) — 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.
#branch=
def branch=(value) -> ::String
-
value (::String) — 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) — 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.
#canonical_filter
def canonical_filter() -> ::String
-
(::String) — 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.
#canonical_filter=
def canonical_filter=(value) -> ::String
-
value (::String) — 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) — 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.
#content_search_spec
def content_search_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec) — A specification for configuring the behavior of content search.
#content_search_spec=
def content_search_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec) — A specification for configuring the behavior of content search.
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec) — A specification for configuring the behavior of content search.
#embedding_spec
def embedding_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec
-
(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec) — Uses the provided embedding to do additional semantic document retrieval.
The retrieval is based on the dot product of
SearchRequest.EmbeddingSpec.EmbeddingVector.vector
and the document embedding that is provided in
SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
#embedding_spec=
def embedding_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec
-
value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec) — Uses the provided embedding to do additional semantic document retrieval.
The retrieval is based on the dot product of
SearchRequest.EmbeddingSpec.EmbeddingVector.vector
and the document embedding that is provided in
SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
-
(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec) — Uses the provided embedding to do additional semantic document retrieval.
The retrieval is based on the dot product of
SearchRequest.EmbeddingSpec.EmbeddingVector.vector
and the document embedding that is provided in
SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
#facet_specs
def facet_specs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>
-
(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>) — 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.
#facet_specs=
def facet_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>
-
value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>) — 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.
-
(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>) — 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.
#filter
def filter() -> ::String
-
(::String) — 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
#filter=
def filter=(value) -> ::String
-
value (::String) — 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) — 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
#image_query
def image_query() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery) — Raw image query.
#image_query=
def image_query=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery) — Raw image query.
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery) — Raw image query.
#offset
def offset() -> ::Integer
-
(::Integer) — 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.
#offset=
def offset=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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.
#order_by
def order_by() -> ::String
-
(::String) — 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 OrderingIf this field is unrecognizable, an
INVALID_ARGUMENT
is returned.
#order_by=
def order_by=(value) -> ::String
-
value (::String) — 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 OrderingIf this field is unrecognizable, an
INVALID_ARGUMENT
is returned.
-
(::String) — 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 OrderingIf this field is unrecognizable, an
INVALID_ARGUMENT
is returned.
#page_size
def page_size() -> ::Integer
-
(::Integer) — Maximum number of Documents
to return. If unspecified, defaults to a reasonable value. The maximum
allowed value is 100. Values above 100 are coerced to 100.
If this field is negative, an
INVALID_ARGUMENT
is returned.
#page_size=
def page_size=(value) -> ::Integer
-
value (::Integer) — Maximum number of Documents
to return. If unspecified, defaults to a reasonable value. The maximum
allowed value is 100. Values above 100 are coerced to 100.
If this field is negative, an
INVALID_ARGUMENT
is returned.
-
(::Integer) — Maximum number of Documents
to return. If unspecified, defaults to a reasonable value. The maximum
allowed value is 100. Values above 100 are coerced to 100.
If this field is negative, an
INVALID_ARGUMENT
is returned.
#page_token
def page_token() -> ::String
-
(::String) — 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.
#page_token=
def page_token=(value) -> ::String
-
value (::String) — 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) — 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.
#params
def params() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::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. 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
#params=
def params=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
-
value (::Google::Protobuf::Map{::String => ::Google::Protobuf::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. 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
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::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. 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
#query
def query() -> ::String
- (::String) — Raw search query.
#query=
def query=(value) -> ::String
- value (::String) — Raw search query.
- (::String) — Raw search query.
#query_expansion_spec
def query_expansion_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec) — The query expansion specification that specifies the conditions under which query expansion occurs.
#query_expansion_spec=
def query_expansion_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec) — The query expansion specification that specifies the conditions under which query expansion occurs.
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec) — The query expansion specification that specifies the conditions under which query expansion occurs.
#ranking_expression
def ranking_expression() -> ::String
-
(::String) — 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)
.
#ranking_expression=
def ranking_expression=(value) -> ::String
-
value (::String) — 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) — 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)
.
#safe_search
def safe_search() -> ::Boolean
- (::Boolean) — Whether to turn on safe search. This is only supported for website search.
#safe_search=
def safe_search=(value) -> ::Boolean
- value (::Boolean) — Whether to turn on safe search. This is only supported for website search.
- (::Boolean) — Whether to turn on safe search. This is only supported for website search.
#serving_config
def serving_config() -> ::String
-
(::String) — Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config
, orprojects/*/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.
#serving_config=
def serving_config=(value) -> ::String
-
value (::String) — Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config
, orprojects/*/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) — Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config
, orprojects/*/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.
#spell_correction_spec
def spell_correction_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec) — The spell correction specification that specifies the mode under which spell correction takes effect.
#spell_correction_spec=
def spell_correction_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec) — The spell correction specification that specifies the mode under which spell correction takes effect.
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec) — The spell correction specification that specifies the mode under which spell correction takes effect.
#user_info
def user_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo
-
(::Google::Cloud::DiscoveryEngine::V1beta::UserInfo) — Information about the end user.
Highly recommended for analytics.
UserInfo.user_agent
is used to deduce
device_type
for analytics.
#user_info=
def user_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo
-
value (::Google::Cloud::DiscoveryEngine::V1beta::UserInfo) — Information about the end user.
Highly recommended for analytics.
UserInfo.user_agent
is used to deduce
device_type
for analytics.
-
(::Google::Cloud::DiscoveryEngine::V1beta::UserInfo) — Information about the end user.
Highly recommended for analytics.
UserInfo.user_agent
is used to deduce
device_type
for analytics.
#user_labels
def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#user_labels=
def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#user_pseudo_id
def user_pseudo_id() -> ::String
-
(::String) — 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.
#user_pseudo_id=
def user_pseudo_id=(value) -> ::String
-
value (::String) — 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) — 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.