Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFieldConfig
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFieldConfig
- 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
Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
Instance Attribute Summary collapse
-
#completable_option ⇒ String
If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.
-
#dynamic_facetable_option ⇒ String
If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet.
-
#field_path ⇒ String
Required.
-
#field_type ⇒ String
Output only.
-
#indexable_option ⇒ String
If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search.
-
#key_property_type ⇒ String
Output only.
-
#recs_filterable_option ⇒ String
If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend.
-
#retrievable_option ⇒ String
If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results.
-
#searchable_option ⇒ String
If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaFieldConfig
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaFieldConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaFieldConfig
Returns a new instance of GoogleCloudDiscoveryengineV1alphaFieldConfig.
1998 1999 2000 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1998 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
1914 1915 1916 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1914 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
1927 1928 1929 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1927 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
1933 1934 1935 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1933 def field_path @field_path end |
#field_type ⇒ String
Output only. Raw type of the field.
Corresponds to the JSON property fieldType
1938 1939 1940 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1938 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
1949 1950 1951 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1949 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
1959 1960 1961 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1959 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
1971 1972 1973 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1971 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
1982 1983 1984 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1982 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
1996 1997 1998 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1996 def searchable_option @searchable_option end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2003 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 |