Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaFieldConfig

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

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaFieldConfig

Returns a new instance of GoogleCloudDiscoveryengineV1alphaFieldConfig.



2546
2547
2548
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2546

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

Instance Attribute Details

#completable_option ⇒ String

If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService. CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just string fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw INVALID_ARGUMENT error. Corresponds to the JSON property completableOption

Returns:

  • (String) 


2462
2463
2464
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2462

def completable_option
  @completable_option
end

#dynamic_facetable_option ⇒ String

If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as object and boolean, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw INVALID_ARGUMENT error. Corresponds to the JSON property dynamicFacetableOption

Returns:

  • (String) 


2475
2476
2477
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2475

def dynamic_facetable_option
  @dynamic_facetable_option
end

#field_path ⇒ String

Required. Field path of the schema field. For example: title, description, release_info.release_year. Corresponds to the JSON property fieldPath

Returns:

  • (String) 


2481
2482
2483
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2481

def field_path
  @field_path
end

#field_type ⇒ String

Output only. Raw type of the field. Corresponds to the JSON property fieldType

Returns:

  • (String) 


2486
2487
2488
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2486

def field_type
  @field_type
end

#indexable_option ⇒ String

If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as object and boolean and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw INVALID_ARGUMENT error. Corresponds to the JSON property indexableOption

Returns:

  • (String) 


2497
2498
2499
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2497

def indexable_option
  @indexable_option
end

#key_property_type ⇒ String

Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are title, description. Full list is defined by keyPropertyMapping in the schema field annotation. If the schema field has a KeyPropertyMapping annotation, indexable_option and searchable_option of this field cannot be modified. Corresponds to the JSON property keyPropertyType

Returns:

  • (String) 


2507
2508
2509
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2507

def key_property_type
  @key_property_type
end

#recs_filterable_option ⇒ String

If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [ FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. Corresponds to the JSON property recsFilterableOption

Returns:

  • (String) 


2519
2520
2521
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2519

def recs_filterable_option
  @recs_filterable_option
end

#retrievable_option ⇒ String

If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as object and boolean, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw INVALID_ARGUMENT error. Corresponds to the JSON property retrievableOption

Returns:

  • (String) 


2530
2531
2532
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2530

def retrievable_option
  @retrievable_option
end

#searchable_option ⇒ String

If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only string fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw INVALID_ARGUMENT error. Corresponds to the JSON property searchableOption

Returns:

  • (String) 


2544
2545
2546
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2544

def searchable_option
  @searchable_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2551

def update!(**args)
  @completable_option = args[:completable_option] if args.key?(:completable_option)
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
  @field_path = args[:field_path] if args.key?(:field_path)
  @field_type = args[:field_type] if args.key?(:field_type)
  @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
  @key_property_type = args[:key_property_type] if args.key?(:key_property_type)
  @recs_filterable_option = args[:recs_filterable_option] if args.key?(:recs_filterable_option)
  @retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
  @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
end