Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Request message for SearchService.Search method.
Instance Attribute Summary collapse
-
#boost_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpec
Boost specification to boost certain documents.
-
#branch ⇒ String
The branch resource name, such as
projects/*/locations/global/collections/ default_collection/dataStores/default_data_store/branches/0
. -
#canonical_filter ⇒ String
The default filter that is applied when a user performs a search without checking any filters on the search page.
-
#content_search_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec
A specification for configuring the behavior of content search.
-
#data_store_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>
Specs defining dataStores to filter on in a search call and configurations for those dataStores.
-
#facet_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestFacetSpec>
Facet specifications for faceted search.
-
#filter ⇒ String
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
-
#image_query ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestImageQuery
Specifies the image query input.
-
#language_code ⇒ String
The BCP-47 language code, such as "en-US" or "sr-Latn".
-
#offset ⇒ Fixnum
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.
-
#order_by ⇒ String
The order in which documents are returned.
-
#page_size ⇒ Fixnum
Maximum number of Documents to return.
-
#page_token ⇒ String
A page token received from a previous SearchService.Search call.
-
#params ⇒ Hash<String,Object>
Additional search parameters.
-
#query ⇒ String
Raw search query.
-
#query_expansion_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
-
#safe_search ⇒ Boolean
(also: #safe_search?)
Whether to turn on safe search.
-
#search_as_you_type_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec
Specification for search as you type in search requests.
-
#session ⇒ String
The session resource name.
-
#session_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
Session specification.
-
#spell_correction_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec
The specification for query spell correction.
-
#user_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserInfo
Information of an end user.
-
#user_labels ⇒ Hash<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.
-
#user_pseudo_id ⇒ String
A unique identifier for tracking visitors.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequest
constructor
A new instance of GoogleCloudDiscoveryengineV1SearchRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequest
Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequest.
6108 6109 6110 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6108 def initialize(**args) update!(**args) end |
Instance Attribute Details
#boost_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpec
Boost specification to boost certain documents.
Corresponds to the JSON property boostSpec
5906 5907 5908 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5906 def boost_spec @boost_spec end |
#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.
Corresponds to the JSON property branch
5914 5915 5916 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5914 def branch @branch end |
#canonical_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.
Corresponds to the JSON property canonicalFilter
5926 5927 5928 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5926 def canonical_filter @canonical_filter end |
#content_search_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec
A specification for configuring the behavior of content search.
Corresponds to the JSON property contentSearchSpec
5931 5932 5933 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5931 def content_search_spec @content_search_spec end |
#data_store_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>
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.
Corresponds to the JSON property dataStoreSpecs
5939 5940 5941 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5939 def data_store_specs @data_store_specs end |
#facet_specs ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestFacetSpec>
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.
Corresponds to the JSON property facetSpecs
5946 5947 5948 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5946 def facet_specs @facet_specs end |
#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
Corresponds to the JSON property filter
5961 5962 5963 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5961 def filter @filter end |
#image_query ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestImageQuery
Specifies the image query input.
Corresponds to the JSON property imageQuery
5966 5967 5968 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5966 def image_query @image_query end |
#language_code ⇒ String
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.
Corresponds to the JSON property languageCode
5974 5975 5976 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5974 def language_code @language_code end |
#offset ⇒ Fixnum
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.
Corresponds to the JSON property offset
5982 5983 5984 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5982 def offset @offset end |
#order_by ⇒ 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.
Corresponds to the JSON property orderBy
5991 5992 5993 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5991 def order_by @order_by end |
#page_size ⇒ Fixnum
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
, Maximum25
. * Websites with advanced indexing: Default25
, Maximum50
. * Other: Default50
, Maximum100
. If this field is negative, anINVALID_ARGUMENT
is returned. Corresponds to the JSON propertypageSize
6000 6001 6002 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6000 def page_size @page_size end |
#page_token ⇒ 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.
Corresponds to the JSON property pageToken
6008 6009 6010 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6008 def page_token @page_token end |
#params ⇒ Hash<String,Object>
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
Corresponds to the JSON property params
6020 6021 6022 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6020 def params @params end |
#query ⇒ String
Raw search query.
Corresponds to the JSON property query
6025 6026 6027 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6025 def query @query end |
#query_expansion_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
Corresponds to the JSON property queryExpansionSpec
6030 6031 6032 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6030 def query_expansion_spec @query_expansion_spec end |
#safe_search ⇒ Boolean Also known as: safe_search?
Whether to turn on safe search. This is only supported for website search.
Corresponds to the JSON property safeSearch
6035 6036 6037 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6035 def safe_search @safe_search end |
#search_as_you_type_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec
Specification for search as you type in search requests.
Corresponds to the JSON property searchAsYouTypeSpec
6041 6042 6043 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6041 def search_as_you_type_spec @search_as_you_type_spec end |
#session ⇒ String
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): 1. Call /search API with the
auto-session mode (see below). 2. 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.
Corresponds to the JSON property session
6062 6063 6064 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6062 def session @session end |
#session_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
Session specification. 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.
Corresponds to the JSON property sessionSpec
6069 6070 6071 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6069 def session_spec @session_spec end |
#spell_correction_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec
The specification for query spell correction.
Corresponds to the JSON property spellCorrectionSpec
6074 6075 6076 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6074 def spell_correction_spec @spell_correction_spec end |
#user_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserInfo
Information of an end user.
Corresponds to the JSON property userInfo
6079 6080 6081 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6079 def user_info @user_info end |
#user_labels ⇒ Hash<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.
Corresponds to the JSON property userLabels
6094 6095 6096 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6094 def user_labels @user_labels end |
#user_pseudo_id ⇒ 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.
Corresponds to the JSON property userPseudoId
6106 6107 6108 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6106 def user_pseudo_id @user_pseudo_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6113 def update!(**args) @boost_spec = args[:boost_spec] if args.key?(:boost_spec) @branch = args[:branch] if args.key?(:branch) @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter) @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec) @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs) @facet_specs = args[:facet_specs] if args.key?(:facet_specs) @filter = args[:filter] if args.key?(:filter) @image_query = args[:image_query] if args.key?(:image_query) @language_code = args[:language_code] if args.key?(:language_code) @offset = args[:offset] if args.key?(:offset) @order_by = args[:order_by] if args.key?(:order_by) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @params = args[:params] if args.key?(:params) @query = args[:query] if args.key?(:query) @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec) @safe_search = args[:safe_search] if args.key?(:safe_search) @search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec) @session = args[:session] if args.key?(:session) @session_spec = args[:session_spec] if args.key?(:session_spec) @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec) @user_info = args[:user_info] if args.key?(:user_info) @user_labels = args[:user_labels] if args.key?(:user_labels) @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id) end |