Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaFieldConfig

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

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.



11490
11491
11492
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11490

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

Instance Attribute Details

#advanced_site_search_data_sourcesArray<String>

If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with in meta tag, and in page map: if this enum is set to METATAGS, we will only index ; if this enum is not set, we will merge them and index . Corresponds to the JSON property advancedSiteSearchDataSources

Returns:

  • (Array<String>)


11375
11376
11377
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11375

def advanced_site_search_data_sources
  @advanced_site_search_data_sources
end

#completable_optionString

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)


11387
11388
11389
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11387

def completable_option
  @completable_option
end

#dynamic_facetable_optionString

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)


11400
11401
11402
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11400

def dynamic_facetable_option
  @dynamic_facetable_option
end

#field_pathString

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

Returns:

  • (String)


11406
11407
11408
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11406

def field_path
  @field_path
end

#field_typeString

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

Returns:

  • (String)


11411
11412
11413
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11411

def field_type
  @field_type
end

#indexable_optionString

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)


11422
11423
11424
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11422

def indexable_option
  @indexable_option
end

#key_property_typeString

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)


11432
11433
11434
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11432

def key_property_type
  @key_property_type
end

#metatag_nameString

Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. Corresponds to the JSON property metatagName

Returns:

  • (String)


11440
11441
11442
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11440

def metatag_name
  @metatag_name
end

#recs_filterable_optionString

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)


11452
11453
11454
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11452

def recs_filterable_option
  @recs_filterable_option
end

#retrievable_optionString

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)


11463
11464
11465
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11463

def retrievable_option
  @retrievable_option
end

#schema_org_pathsArray<String>

Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at schema.org. It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from _root, with a period . as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished Corresponds to the JSON property schemaOrgPaths

Returns:

  • (Array<String>)


11474
11475
11476
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11474

def schema_org_paths
  @schema_org_paths
end

#searchable_optionString

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)


11488
11489
11490
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11488

def searchable_option
  @searchable_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11495

def update!(**args)
  @advanced_site_search_data_sources = args[:advanced_site_search_data_sources] if args.key?(:advanced_site_search_data_sources)
  @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)
  @metatag_name = args[:metatag_name] if args.key?(:metatag_name)
  @recs_filterable_option = args[:recs_filterable_option] if args.key?(:recs_filterable_option)
  @retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
  @schema_org_paths = args[:schema_org_paths] if args.key?(:schema_org_paths)
  @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
end