| Field | Type | Required | Description |
|---|---|---|---|
name |
Optional[str] | ➖ | The name of the property in the DocumentMetadata (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. |
display_label |
Optional[str] | ➖ | The user friendly label for the property. |
display_label_plural |
Optional[str] | ➖ | The user friendly label for the property that will be used if a plural context. |
property_type |
Optional[models.PropertyType] | ➖ | The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. |
ui_options |
Optional[models.UIOptions] | ➖ | N/A |
hide_ui_facet |
Optional[bool] | ➖ | If true then the property will not show up as a facet in the UI. |
ui_facet_order |
Optional[int] | ➖ | Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. |
skip_indexing |
Optional[bool] | ➖ | If true then the property will not be indexed for retrieval and ranking. |
group |
Optional[str] | ➖ | The unique identifier of the PropertyGroup to which this property belongs. |