Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.3 KB

SchemaField.md

File metadata and controls

18 lines (13 loc) · 1.3 KB

SchemaField

SchemaField defines the properties of a field in the schema.

Properties

Name Type Description Notes
mode SchemaFieldMode
name str The name of the field.
type SchemaFieldType
array bool Array indicates if the field is an array of values. For example, if `type` is string and `array` is `true`, then the field is an array of strings. [optional]
array_length int The required length of the array, if `array` is `true`. This allows you to enforce that an array contains an exact number of items. For example, to store a 2x2 vector, you could set `type` to float, `array` to `true` and `array_length` to `4`. [optional]
description str The description of the field. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]