Class GoogleCloudDiscoveryengineV1alphaFieldConfig

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

Inheritance
object
GoogleCloudDiscoveryengineV1alphaFieldConfig
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaFieldConfig : IDirectResponseSchema

Properties

AdvancedSiteSearchDataSources

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 .

Declaration
[JsonProperty("advancedSiteSearchDataSources")]
public virtual IList<string> AdvancedSiteSearchDataSources { get; set; }
Property Value
Type Description
IList<string>

CompletableOption

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.

Declaration
[JsonProperty("completableOption")]
public virtual string CompletableOption { get; set; }
Property Value
Type Description
string

DynamicFacetableOption

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.

Declaration
[JsonProperty("dynamicFacetableOption")]
public virtual string DynamicFacetableOption { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FieldPath

Required. Field path of the schema field. For example: title, description, release_info.release_year.

Declaration
[JsonProperty("fieldPath")]
public virtual string FieldPath { get; set; }
Property Value
Type Description
string

FieldType

Output only. Raw type of the field.

Declaration
[JsonProperty("fieldType")]
public virtual string FieldType { get; set; }
Property Value
Type Description
string

IndexableOption

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.

Declaration
[JsonProperty("indexableOption")]
public virtual string IndexableOption { get; set; }
Property Value
Type Description
string

KeyPropertyType

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.

Declaration
[JsonProperty("keyPropertyType")]
public virtual string KeyPropertyType { get; set; }
Property Value
Type Description
string

MetatagName

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.

Declaration
[JsonProperty("metatagName")]
public virtual string MetatagName { get; set; }
Property Value
Type Description
string

RecsFilterableOption

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.

Declaration
[JsonProperty("recsFilterableOption")]
public virtual string RecsFilterableOption { get; set; }
Property Value
Type Description
string

RetrievableOption

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.

Declaration
[JsonProperty("retrievableOption")]
public virtual string RetrievableOption { get; set; }
Property Value
Type Description
string

SchemaOrgPaths

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

Declaration
[JsonProperty("schemaOrgPaths")]
public virtual IList<string> SchemaOrgPaths { get; set; }
Property Value
Type Description
IList<string>

SearchableOption

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.

Declaration
[JsonProperty("searchableOption")]
public virtual string SearchableOption { get; set; }
Property Value
Type Description
string

Implements