Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Request message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSearchRequest

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchRequest.



16147
16148
16149
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16147

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec

Boost specification to boost certain documents. Corresponds to the JSON property boostSpec

Returns:



15899
15900
15901
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15899

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

Returns:

  • (String) 


15907
15908
15909
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15907

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

Returns:

  • (String) 


15919
15920
15921
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15919

def canonical_filter
  @canonical_filter
end

#content_search_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

A specification for configuring the behavior of content search. Corresponds to the JSON property contentSearchSpec

Returns:



15924
15925
15926
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15924

def content_search_spec
  @content_search_spec
end

#data_store_specs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>

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

Returns:



15932
15933
15934
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15932

def data_store_specs
  @data_store_specs
end

#embedding_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec

The specification that uses customized query embedding vector to do semantic document retrieval. Corresponds to the JSON property embeddingSpec

Returns:



15938
15939
15940
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15938

def embedding_spec
  @embedding_spec
end

#facet_specs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec>

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

Returns:



15945
15946
15947
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15945

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

Returns:

  • (String) 


15960
15961
15962
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15960

def filter
  @filter
end

#image_query ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery

Specifies the image query input. Corresponds to the JSON property imageQuery

Returns:



15965
15966
15967
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15965

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

Returns:

  • (String) 


15973
15974
15975
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15973

def language_code
  @language_code
end

#natural_language_query_understanding_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests. Corresponds to the JSON property naturalLanguageQueryUnderstandingSpec

Returns:



15979
15980
15981
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15979

def natural_language_query_understanding_spec
  @natural_language_query_understanding_spec
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

Returns:

  • (Fixnum) 


15987
15988
15989
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15987

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

Returns:

  • (String) 


15996
15997
15998
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15996

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, 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. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


16005
16006
16007
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16005

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

Returns:

  • (String) 


16013
16014
16015
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16013

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

Returns:

  • (Hash<String,Object>) 


16025
16026
16027
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16025

def params
  @params
end

#query ⇒ String

Raw search query. Corresponds to the JSON property query

Returns:

  • (String) 


16030
16031
16032
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16030

def query
  @query
end

#query_expansion_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur. Corresponds to the JSON property queryExpansionSpec

Returns:



16035
16036
16037
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16035

def query_expansion_spec
  @query_expansion_spec
end

#ranking_expression ⇒ 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 joined 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). Corresponds to the JSON property rankingExpression

Returns:

  • (String) 


16051
16052
16053
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16051

def ranking_expression
  @ranking_expression
end

#region_code ⇒ String

The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided. Corresponds to the JSON property regionCode

Returns:

  • (String) 


16059
16060
16061
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16059

def region_code
  @region_code
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

Returns:

  • (Boolean) 


16064
16065
16066
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16064

def safe_search
  @safe_search
end

#search_as_you_type_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec

Specification for search as you type in search requests. Corresponds to the JSON property searchAsYouTypeSpec

Returns:



16070
16071
16072
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16070

def search_as_you_type_spec
  @search_as_you_type_spec
end

#serving_config ⇒ 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. Corresponds to the JSON property servingConfig

Returns:

  • (String) 


16080
16081
16082
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16080

def serving_config
  @serving_config
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

Returns:

  • (String) 


16101
16102
16103
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16101

def session
  @session
end

#session_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec

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

Returns:



16108
16109
16110
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16108

def session_spec
  @session_spec
end

#spell_correction_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec

The specification for query spell correction. Corresponds to the JSON property spellCorrectionSpec

Returns:



16113
16114
16115
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16113

def spell_correction_spec
  @spell_correction_spec
end

#user_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaUserInfo

Information of an end user. Corresponds to the JSON property userInfo

Returns:



16118
16119
16120
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16118

def 
  @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

Returns:

  • (Hash<String,String>) 


16133
16134
16135
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16133

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

Returns:

  • (String) 


16145
16146
16147
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16145

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 16152

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)
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
  @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)
  @natural_language_query_understanding_spec = args[:natural_language_query_understanding_spec] if args.key?(:natural_language_query_understanding_spec)
  @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)
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
  @region_code = args[:region_code] if args.key?(:region_code)
  @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)
  @serving_config = args[:serving_config] if args.key?(:serving_config)
  @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