- [Resource: Schema](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema)
  - [JSON representation](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SCHEMA_REPRESENTATION)
  - [FieldConfig](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig)
    - [JSON representation](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.SCHEMA_REPRESENTATION)
  - [FieldType](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldType)
  - [IndexableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption)
  - [DynamicFacetableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption)
  - [SearchableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption)
  - [RetrievableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.RetrievableOption)
  - [CompletableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.CompletableOption)
  - [FilterableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption)
  - [AdvancedSiteSearchDataSource](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.AdvancedSiteSearchDataSource)
  - [PartialMatchableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PartialMatchableOption)
  - [PrefixMatchableOption](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PrefixMatchableOption)
  - [SearchableFieldImportance](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableFieldImportance)
- [Methods](https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#METHODS_SUMMARY)

## Resource: Schema

Defines the structure and layout of a type of document data.

| JSON representation |
|---|
| ``` { "name": string, "fieldConfigs": [ { object (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig`) } ], // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "structSchema": { object }, "jsonSchema": string // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `fieldConfigs[]` | ``object (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig`)`` Output only. Configurations for fields of the schema. |
| Schema representation. One of `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FIELDS.struct_schema` or `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FIELDS.json_schema` should be provided otherwise an `INVALID_ARGUMENT` error is thrown. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `structSchema` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` The structured representation of the schema. |
| `jsonSchema` | `string` The JSON representation of the schema. |
| End of mutually exclusive fields. ||

### FieldConfig

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

| JSON representation |
|---|
| ``` { "fieldPath": string, "fieldType": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldType`), "indexableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption`), "dynamicFacetableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption`), "searchableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption`), "retrievableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.RetrievableOption`), "completableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.CompletableOption`), "recsFilterableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption`), "keyPropertyType": string, "advancedSiteSearchDataSources": [ enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.AdvancedSiteSearchDataSource`) ], "schemaOrgPaths": [ string ], "metatagName": string, "partialMatchableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PartialMatchableOption`), "prefixMatchableOption": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PrefixMatchableOption`), "searchableFieldImportance": enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableFieldImportance`) } ``` |

| Fields ||
|---|---|
| `fieldPath` | `string` Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. |
| `fieldType` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldType`)`` Output only. Raw type of the field. |
| `indexableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.indexable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption.ENUM_VALUES.INDEXABLE_ENABLED`, field values are indexed so that it can be filtered or faceted in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#google.cloud.discoveryengine.v1alpha.SearchService.Search`. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.indexable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption.ENUM_VALUES.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 `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.indexable_option` setting, and setting `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.indexable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `dynamicFacetableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.dynamic_facetable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption.ENUM_VALUES.DYNAMIC_FACETABLE_ENABLED`, field values are available for dynamic facet. Could only be `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption.ENUM_VALUES.DYNAMIC_FACETABLE_DISABLED` if `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.indexable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.IndexableOption.ENUM_VALUES.INDEXABLE_DISABLED`. Otherwise, an `INVALID_ARGUMENT` error will be returned. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.dynamic_facetable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.DynamicFacetableOption.ENUM_VALUES.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 `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.dynamic_facetable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `searchableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.searchable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption.ENUM_VALUES.SEARCHABLE_ENABLED`, field values are searchable by text queries in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#google.cloud.discoveryengine.v1alpha.SearchService.Search`. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption.ENUM_VALUES.SEARCHABLE_ENABLED` but field type is numerical, field values will not be searchable by text queries in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#google.cloud.discoveryengine.v1alpha.SearchService.Search`, as there are no text values associated to numerical fields. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.searchable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableOption.ENUM_VALUES.SEARCHABLE_DISABLED` for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.searchable_option`. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.searchable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `retrievableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.RetrievableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.retrievable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.RetrievableOption.ENUM_VALUES.RETRIEVABLE_ENABLED`, field values are included in the search results. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.retrievable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.RetrievableOption.ENUM_VALUES.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 `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.retrievable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `completableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.CompletableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.completable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.CompletableOption.ENUM_VALUES.COMPLETABLE_ENABLED`, field values are directly used and returned as suggestions for Autocomplete in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores/completeQuery#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery`. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.completable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.CompletableOption.ENUM_VALUES.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 `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.completable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `recsFilterableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption`)`` If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.recs_filterable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption.ENUM_VALUES.FILTERABLE_ENABLED`, field values are filterable by filter expression in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/recommend#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption.ENUM_VALUES.FILTERABLE_ENABLED` but the field type is numerical, field values are not filterable by text queries in `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/recommend#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. Only textual fields are supported. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.recs_filterable_option` is unset, the default setting is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FilterableOption.ENUM_VALUES.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. |
| `keyPropertyType` | `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, `indexableOption` and `searchableOption` of this field cannot be modified. |
| `advancedSiteSearchDataSources[]` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.AdvancedSiteSearchDataSource`)`` 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 `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`. |
| `schemaOrgPaths[]` | `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](https://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 |
| `metatagName` | `string` 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 `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.field_path` will be used to extract metatag. |
| `partialMatchableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PartialMatchableOption`)`` Optional. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.partial_matchable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PartialMatchableOption.ENUM_VALUES.PARTIAL_MATCHABLE_OPTION_ENABLED`, field values are partial matchable. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.partial_matchable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PartialMatchableOption.ENUM_VALUES.PARTIAL_MATCHABLE_OPTION_DISABLED` for fields that support setting partial matchable options. For those fields that do not support setting partial matchable options, the server will skip partial matchable option setting, and setting `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.partial_matchable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `prefixMatchableOption` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PrefixMatchableOption`)`` Optional. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.prefix_matchable_option` is `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PrefixMatchableOption.ENUM_VALUES.PREFIX_MATCHABLE_OPTION_ENABLED`, field values are prefix matchable. If `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.prefix_matchable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.PrefixMatchableOption.ENUM_VALUES.PREFIX_MATCHABLE_OPTION_DISABLED` for fields that support setting prefix matchable options. For those fields that do not support setting prefix matchable options, the server will skip prefix matchable option setting, and setting `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.FieldConfig.FIELDS.prefix_matchable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `searchableFieldImportance` | ``enum (`https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema.SearchableFieldImportance`)`` Optional. Specifies the importance of the field when `searchableOption` is `SEARCHABLE_ENABLED`. If `searchableOption` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchableOption` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). |

### FieldType

Field value type in the Schema.

| Enums ||
|---|---|
| `FIELD_TYPE_UNSPECIFIED` | Field type is unspecified. |
| `OBJECT` | Field value type is Object. |
| `STRING` | Field value type is String. |
| `NUMBER` | Field value type is Number. |
| `INTEGER` | Field value type is Integer. |
| `BOOLEAN` | Field value type is Boolean. |
| `GEOLOCATION` | Field value type is Geolocation. Geolocation is expressed as an object with the following keys: - `id`: a string representing the location id - `longitude`: a number representing the longitude coordinate of the location - `latitude`: a number repesenting the latitude coordinate of the location - `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided. |
| `DATETIME` | Field value type is Datetime. Datetime can be expressed as either: - a number representing milliseconds-since-the-epoch - a string representing milliseconds-since-the-epoch. e.g. `"1420070400001"` - a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` |

### IndexableOption

The setting of Indexable options in schema.

| Enums ||
|---|---|
| `INDEXABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `INDEXABLE_ENABLED` | Indexable option enabled for a schema field. |
| `INDEXABLE_DISABLED` | Indexable option disabled for a schema field. |

### DynamicFacetableOption

The status of the dynamic facetable option of a schema field.

| Enums ||
|---|---|
| `DYNAMIC_FACETABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `DYNAMIC_FACETABLE_ENABLED` | Dynamic facetable option enabled for a schema field. |
| `DYNAMIC_FACETABLE_DISABLED` | Dynamic facetable option disabled for a schema field. |

### SearchableOption

The setting of Searchable options in schema.

| Enums ||
|---|---|
| `SEARCHABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `SEARCHABLE_ENABLED` | Searchable option enabled for a schema field. |
| `SEARCHABLE_DISABLED` | Searchable option disabled for a schema field. |

### RetrievableOption

The setting of Retrievable options in schema.

| Enums ||
|---|---|
| `RETRIEVABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `RETRIEVABLE_ENABLED` | Retrievable option enabled for a schema field. |
| `RETRIEVABLE_DISABLED` | Retrievable option disabled for a schema field. |

### CompletableOption

The setting of Completable options in schema.

| Enums ||
|---|---|
| `COMPLETABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `COMPLETABLE_ENABLED` | Completable option enabled for a schema field. |
| `COMPLETABLE_DISABLED` | Completable option disabled for a schema field. |

### FilterableOption

Sets the filterable option for schema fields.

| Enums ||
|---|---|
| `FILTERABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `FILTERABLE_ENABLED` | Filterable option enabled for a schema field. |
| `FILTERABLE_DISABLED` | Filterable option disabled for a schema field. |

### AdvancedSiteSearchDataSource

Optional source of the advanced site search field.

| Enums ||
|---|---|
| `ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED` | Value used when unset. |
| `METATAGS` | Retrieve value from meta tag. |
| `PAGEMAP` | Retrieve value from page map. |
| `URI_PATTERN_MAPPING` | Retrieve value from the attributes set by `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.siteSearchEngine/setUriPatternDocumentData#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData` API. |
| `SCHEMA_ORG` | Retrieve value from schema.org data. |

### PartialMatchableOption

The setting of Partial Matchable options in schema.

| Enums ||
|---|---|
| `PARTIAL_MATCHABLE_OPTION_UNSPECIFIED` | value used when unset. |
| `PARTIAL_MATCHABLE_OPTION_ENABLED` | Partial Matchable option enabled. |
| `PARTIAL_MATCHABLE_OPTION_DISABLED` | Partial Matchable option disabled. |

### PrefixMatchableOption

The setting of Prefix Matchable options in schema.

| Enums ||
|---|---|
| `PREFIX_MATCHABLE_OPTION_UNSPECIFIED` | value used when unset. |
| `PREFIX_MATCHABLE_OPTION_ENABLED` | Prefix Matchable option enabled. |
| `PREFIX_MATCHABLE_OPTION_DISABLED` | Prefix Matchable option disabled. |

### SearchableFieldImportance

Specifies the importance of the field for search. New values are not expected to be added to this enum.

| Enums ||
|---|---|
| `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED` | value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable. |
| `VERY_LOW_IMPORTANCE` | Provides a tiny signal for search. |
| `LOW_IMPORTANCE` | Indicates the field is used for search, but is less important than the default. |
| `DEFAULT_IMPORTANCE` | Default importance. Equivalent to previous behavior. |
| `HIGH_IMPORTANCE` | More important than default fields. |
| `VERY_HIGH_IMPORTANCE` | Most important field for search. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas/create` | Creates a `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema`. |
| ### `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas/delete` | Deletes a `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema`. |
| ### `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas/get` | Gets a `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema`. |
| ### `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas/list` | Gets a list of `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema`s. |
| ### `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas/patch` | Updates a `https://docs.cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.schemas#Schema`. |