Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchRequest (v0.8.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::BoostSpec
Returns

#boost_spec=

def boost_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec
Parameter
Returns

#branch

def branch() -> ::String
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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::V1::SearchRequest::ContentSearchSpec
Returns

#content_search_spec=

def content_search_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec
Parameter
Returns

#data_store_specs

def data_store_specs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.

#data_store_specs=

def data_store_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>
Parameter
  • value (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.
Returns
  • (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>) — 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.

#facet_specs

def facet_specs() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec>
Returns

#facet_specs=

def facet_specs=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec>
Parameter
Returns

#filter

def filter() -> ::String
Returns
  • (::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
Parameter
  • 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

Returns
  • (::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::V1::SearchRequest::ImageQuery
Returns

#image_query=

def image_query=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery
Parameter
Returns

#offset

def offset() -> ::Integer
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::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 for retail search, see Ordering

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#order_by=

def order_by=(value) -> ::String
Parameter
  • 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 for retail search, see Ordering

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns
  • (::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 for retail search, see Ordering

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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}
Returns
  • (::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. 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

#params=

def params=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Parameter
  • 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. 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
Returns
  • (::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. 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

#query

def query() -> ::String
Returns
  • (::String) — Raw search query.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Raw search query.
Returns
  • (::String) — Raw search query.

#query_expansion_spec

def query_expansion_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec
Returns

#query_expansion_spec=

def query_expansion_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec
Parameter
Returns

#safe_search

def safe_search() -> ::Boolean
Returns
  • (::Boolean) — Whether to turn on safe search. This is only supported for website search.

#safe_search=

def safe_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to turn on safe search. This is only supported for website search.
Returns
  • (::Boolean) — Whether to turn on safe search. This is only supported for website search.

#serving_config

def serving_config() -> ::String
Returns
  • (::String) — 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.

#serving_config=

def serving_config=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#spell_correction_spec

def spell_correction_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec
Returns

#spell_correction_spec=

def spell_correction_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec
Parameter
Returns

#user_info

def user_info() -> ::Google::Cloud::DiscoveryEngine::V1::UserInfo
Returns

#user_info=

def user_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::UserInfo
Parameter
Returns

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::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}
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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.