Partilhar via


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.

enumDescriptions

Descrições para cada valor de enumeração.

estimateSourceAndConfidence

Devolve a fonte de aterramento e confiança.

examples

Exemplos de valores de campo.

itemDefinition

Esquema de tipo 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 de Propriedade

description

Descrição do campo.

description?: string

Valor de Propriedade

string

enum

Enumeração dos possíveis valores de campo.

enum?: string[]

Valor de Propriedade

string[]

enumDescriptions

Descrições para cada valor de enumeração.

enumDescriptions?: Record<string, string>

Valor de Propriedade

Record<string, string>

estimateSourceAndConfidence

Devolve a fonte de aterramento e confiança.

estimateSourceAndConfidence?: boolean

Valor de Propriedade

boolean

examples

Exemplos de valores de campo.

examples?: string[]

Valor de Propriedade

string[]

itemDefinition

Esquema de tipo de campo de cada elemento do array, se o tipo for o array.

itemDefinition?: ContentFieldDefinition

Valor de Propriedade

method

Método de geração.

method?: GenerationMethod

Valor de Propriedade

properties

Subcampos nomeados, se o tipo for objeto.

properties?: Record<string, ContentFieldDefinition>

Valor de Propriedade

Record<string, ContentFieldDefinition>

ref

Referência a outra definição de campo.

ref?: string

Valor de Propriedade

string

type

Tipo de dados semânticos do valor do campo.

type?: ContentFieldType

Valor de Propriedade