ContentFieldDefinition interface
Definição do campo usando uma sintaxe semelhante a um esquema JSON.
Propriedades
| description | Descrição do campo. |
| enum | Enumeração dos possíveis valores de campo. |
| enum |
Descrições para cada valor de enumeração. |
| estimate |
Retorne à fonte de aterramento e confiança. |
| examples | Exemplos de valores de campo. |
| item |
Esquema de tipos de campo de cada elemento do array, se o tipo for o array. |
| method | Método de geração. |
| properties | Subcampos nomeados, se o tipo for objeto. |
| ref | Referência a outra definição de campo. |
| type | Tipo de dados semânticos do valor do campo. |
Detalhes da propriedade
description
Descrição do campo.
description?: string
Valor da propriedade
string
enum
Enumeração dos possíveis valores de campo.
enum?: string[]
Valor da propriedade
string[]
enumDescriptions
Descrições para cada valor de enumeração.
enumDescriptions?: Record<string, string>
Valor da propriedade
Record<string, string>
estimateSourceAndConfidence
Retorne à fonte de aterramento e confiança.
estimateSourceAndConfidence?: boolean
Valor da propriedade
boolean
examples
Exemplos de valores de campo.
examples?: string[]
Valor da propriedade
string[]
itemDefinition
Esquema de tipos de campo de cada elemento do array, se o tipo for o array.
itemDefinition?: ContentFieldDefinition
Valor da propriedade
method
properties
Subcampos nomeados, se o tipo for objeto.
properties?: Record<string, ContentFieldDefinition>
Valor da propriedade
Record<string, ContentFieldDefinition>
ref
Referência a outra definição de campo.
ref?: string
Valor da propriedade
string
type
Tipo de dados semânticos do valor do campo.
type?: ContentFieldType