DataSchemaField
in package
implements
Stringable
Data Schema Field.
Table of Contents
Interfaces
- Stringable
Properties
- $classificationValues : array<string|int, string>|null
- $description : string|null
- $guidelines : string|null
- $isArray : bool
- $name : string
- $nestedFields : array<string, int|float|string|bool|null|array<string|int, mixed>>|null
- $title : string
- $type : string
- $uniqueValues : bool|null
Methods
- __construct() : mixed
- __toString() : string
- toJson() : array<string, int|float|string|bool|null|array<string|int, mixed>>
Properties
$classificationValues
public
array<string|int, string>|null
$classificationValues
Allowed values when type is classification. Leave empty for other types.
$description
public
string|null
$description
Detailed description of what this field represents.
$guidelines
public
string|null
$guidelines
Optional extraction guidelines.
$isArray
public
bool
$isArray
Whether this field can contain multiple values.
$name
public
string
$name
Name of the field in the data schema.
$nestedFields
public
array<string, int|float|string|bool|null|array<string|int, mixed>>|null
$nestedFields
Subfields when type is nested_object. Leave empty for other types.
$title
public
string
$title
Display name for the field. Also impacts inference results.
$type
public
string
$type
Data type of the field.
$uniqueValues
public
bool|null
$uniqueValues
Whether to remove duplicate values in the array.
Methods
__construct()
public
__construct(array<string, int|float|string|bool|null|array<string|int, mixed>> $rawResponse) : mixed
Parameters
- $rawResponse : array<string, int|float|string|bool|null|array<string|int, mixed>>
-
Raw server response array.
__toString()
public
__toString() : string
Return values
string —String representation.
toJson()
public
toJson() : array<string, int|float|string|bool|null|array<string|int, mixed>>
Return values
array<string, int|float|string|bool|null|array<string|int, mixed>> —JSON representation.