Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSearchRequest

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchRequest.



19982
19983
19984
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19982

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec

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

Returns:



19713
19714
19715
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19713

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) 


19721
19722
19723
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19721

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) 


19733
19734
19735
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19733

def canonical_filter
  @canonical_filter
end

#content_search_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

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

Returns:



19738
19739
19740
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19738

def content_search_spec
  @content_search_spec
end

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

Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. Corresponds to the JSON property dataStoreSpecs

Returns:



19746
19747
19748
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19746

def data_store_specs
  @data_store_specs
end

#embedding_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec

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

Returns:



19752
19753
19754
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19752

def embedding_spec
  @embedding_spec
end

#facet_specs ⇒ Array<Google::Apis::DiscoveryengineV1::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:



19759
19760
19761
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19759

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) 


19774
19775
19776
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19774

def filter
  @filter
end

#image_query ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery

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

Returns:



19779
19780
19781
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19779

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) 


19787
19788
19789
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19787

def language_code
  @language_code
end

#natural_language_query_understanding_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec

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

Returns:



19793
19794
19795
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19793

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) 


19801
19802
19803
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19801

def offset
  @offset
end

#one_box_page_size ⇒ Fixnum

The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. Corresponds to the JSON property oneBoxPageSize

Returns:

  • (Fixnum) 


19807
19808
19809
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19807

def one_box_page_size
  @one_box_page_size
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 the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property orderBy

Returns:

  • (String) 


19819
19820
19821
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19819

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) 


19828
19829
19830
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19828

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) 


19836
19837
19838
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19836

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>) 


19848
19849
19850
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19848

def params
  @params
end

#personalization_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec

The specification for personalization. Corresponds to the JSON property personalizationSpec

Returns:



19853
19854
19855
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19853

def personalization_spec
  @personalization_spec
end

#query ⇒ String

Raw search query. Corresponds to the JSON property query

Returns:

  • (String) 


19858
19859
19860
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19858

def query
  @query
end

#query_expansion_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec

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

Returns:



19863
19864
19865
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19863

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) 


19879
19880
19881
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19879

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) 


19887
19888
19889
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19887

def region_code
  @region_code
end

#relevance_threshold ⇒ String

The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. Corresponds to the JSON property relevanceThreshold

Returns:

  • (String) 


19894
19895
19896
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19894

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


19899
19900
19901
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19899

def safe_search
  @safe_search
end

#search_as_you_type_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec

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

Returns:



19905
19906
19907
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19905

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) 


19915
19916
19917
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19915

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) 


19936
19937
19938
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19936

def session
  @session
end

#session_spec ⇒ Google::Apis::DiscoveryengineV1::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:



19943
19944
19945
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19943

def session_spec
  @session_spec
end

#spell_correction_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec

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

Returns:



19948
19949
19950
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19948

def spell_correction_spec
  @spell_correction_spec
end

#user_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaUserInfo

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

Returns:



19953
19954
19955
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19953

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>) 


19968
19969
19970
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19968

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) 


19980
19981
19982
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19980

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19987

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)
  @one_box_page_size = args[:one_box_page_size] if args.key?(:one_box_page_size)
  @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)
  @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
  @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)
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
  @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