Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec.



16961
16962
16963
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16961

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

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

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

Returns:



16928
16929
16930
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16928

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) 


16936
16937
16938
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16936

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) 


16944
16945
16946
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16944

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) 


16951
16952
16953
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16951

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) 


16959
16960
16961
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16959

def num_results
  @num_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16966
16967
16968
16969
16970
16971
16972
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16966

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