Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec

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

Overview

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec.



30430
30431
30432
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30430

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec

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

Returns:



30397
30398
30399
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30397

def boost_spec
  @boost_spec
end

#custom_search_operators ⇒ String

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators. Corresponds to the JSON property customSearchOperators

Returns:

  • (String) 


30405
30406
30407
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30405

def custom_search_operators
  @custom_search_operators
end

#data_store ⇒ String

Required. Full resource name of DataStore, such as projects/project/ locations/location/collections/collection_id/dataStores/data_store_id`. The path must include the project number, project id is not supported for this field. Corresponds to the JSON propertydataStore`

Returns:

  • (String) 


30413
30414
30415
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30413

def data_store
  @data_store
end

#filter ⇒ String

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering Corresponds to the JSON property filter

Returns:

  • (String) 


30420
30421
30422
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30420

def filter
  @filter
end

#num_results ⇒ Fixnum

Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest. num_results_per_data_store are specified, this field will be used. Corresponds to the JSON property numResults

Returns:

  • (Fixnum) 


30428
30429
30430
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30428

def num_results
  @num_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30435
30436
30437
30438
30439
30440
30441
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 30435

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
  @data_store = args[:data_store] if args.key?(:data_store)
  @filter = args[:filter] if args.key?(:filter)
  @num_results = args[:num_results] if args.key?(:num_results)
end