Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequest.



3583
3584
3585
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3583

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

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

Returns:



3413
3414
3415
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3413

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) 


3421
3422
3423
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3421

def branch
  @branch
end

#content_search_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

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

Returns:



3426
3427
3428
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3426

def content_search_spec
  @content_search_spec
end

#embedding_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec

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

Returns:



3432
3433
3434
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3432

def embedding_spec
  @embedding_spec
end

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

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:



3439
3440
3441
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3439

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) 


3454
3455
3456
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3454

def filter
  @filter
end

#image_query ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery

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

Returns:



3459
3460
3461
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3459

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


3467
3468
3469
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3467

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, see Ordering If this field is unrecognizable, an INVALID_ARGUMENT is returned. Corresponds to the JSON property orderBy

Returns:

  • (String) 


3476
3477
3478
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3476

def order_by
  @order_by
end

#page_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3483
3484
3485
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3483

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) 


3491
3492
3493
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3491

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

Returns:

  • (Hash<String,Object>) 


3503
3504
3505
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3503

def params
  @params
end

#query ⇒ String

Raw search query. Corresponds to the JSON property query

Returns:

  • (String) 


3508
3509
3510
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3508

def query
  @query
end

#query_expansion_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec

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

Returns:



3513
3514
3515
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3513

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

Returns:

  • (String) 


3528
3529
3530
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3528

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


3533
3534
3535
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3533

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


3544
3545
3546
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3544

def serving_config
  @serving_config
end

#spell_correction_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec

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

Returns:



3549
3550
3551
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3549

def spell_correction_spec
  @spell_correction_spec
end

#user_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo

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

Returns:



3554
3555
3556
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3554

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


3569
3570
3571
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3569

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) 


3581
3582
3583
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3581

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3588

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @branch = args[:branch] if args.key?(:branch)
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
  @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)
  @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)
  @safe_search = args[:safe_search] if args.key?(:safe_search)
  @serving_config = args[:serving_config] if args.key?(:serving_config)
  @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