Get Autoschema
{
"message": "<string>",
"metadata": {
"total_generated": 123
},
"data": [
{
"column_name": "<string>",
"column_type": "text",
"transform_type": "extraction",
"task_description": "<string>",
"operations": [
{
"column_name": "<string>",
"column_type": "text",
"transform_type": "extraction",
"task_description": "<string>",
"operations": [
{}
],
"output_values": {},
"has_default": true,
"default_value": {}
}
],
"output_values": {},
"has_default": true,
"default_value": {},
"id": "<string>"
}
]
}Authorizations
Path Parameters
The transform_id to get the autoschema for
Response
Name of the column to be transformed. Any alphanumeric characters are allowed. Must be unique.
TransformColumnType is an enumeration that defines various data types for transforming columns.
Attributes:
text (str): Represents a text data type.
integer (str): Represents an integer data type. (Deprecated in Jan 2025: Use number instead)
numeric (str): Represents a numeric data type. (Deprecated in Jan 2025: Use number instead)
boolean (str): Represents a boolean data type.
list (str): Represents a list data type.
object (str): Represents an object data type.
string (str): Represents a string data type. (Deprecated in Jan 2025: Use text instead)
number (str): Represents a number data type.
time (str): Represents a time data type.
date (str): Represents a date data type.
text[] (str): Represents an array of text data type. (Deprecated in Jan 2025)
jsonb (str): Represents a JSONB data type. (Deprecated in Jan 2025)
Note:
Because of upcoming changes, please use `list`, `object`, `text`, `date`, `time`, and `number` going forward.
text, integer, numeric, boolean, list, object, string, number, time, date, text[], jsonb Description of the task to be performed
Type of transformation to be applied.
extraction, classification, generation, manual The default value to use if has_default is true and no value is found in the document. The value you should return is stored under the 'value' key.
If true, use the default value specified in default_value. If false, return null if no value found.
Required when column_type is object or list. Defines the structure of object or list operations. If column_type is list, then operations should only be of length 1 since list can only be of one type. If column_type is object, then operations can be longer of length one (and optionally be nested.)
Name of the column to be transformed. Any alphanumeric characters are allowed. Must be unique.
TransformColumnType is an enumeration that defines various data types for transforming columns.
Attributes:
text (str): Represents a text data type.
integer (str): Represents an integer data type. (Deprecated in Jan 2025: Use number instead)
numeric (str): Represents a numeric data type. (Deprecated in Jan 2025: Use number instead)
boolean (str): Represents a boolean data type.
list (str): Represents a list data type.
object (str): Represents an object data type.
string (str): Represents a string data type. (Deprecated in Jan 2025: Use text instead)
number (str): Represents a number data type.
time (str): Represents a time data type.
date (str): Represents a date data type.
text[] (str): Represents an array of text data type. (Deprecated in Jan 2025)
jsonb (str): Represents a JSONB data type. (Deprecated in Jan 2025)
Note:
Because of upcoming changes, please use `list`, `object`, `text`, `date`, `time`, and `number` going forward.
text, integer, numeric, boolean, list, object, string, number, time, date, text[], jsonb Description of the task to be performed
Type of transformation to be applied.
extraction, classification, generation, manual The default value to use if has_default is true and no value is found in the document. The value you should return is stored under the 'value' key.
If true, use the default value specified in default_value. If false, return null if no value found.
Required when column_type is object or list. Defines the structure of object or list operations. If column_type is list, then operations should only be of length 1 since list can only be of one type. If column_type is object, then operations can be longer of length one (and optionally be nested.)
Name of the column to be transformed. Any alphanumeric characters are allowed. Must be unique.
TransformColumnType is an enumeration that defines various data types for transforming columns.
Attributes:
text (str): Represents a text data type.
integer (str): Represents an integer data type. (Deprecated in Jan 2025: Use number instead)
numeric (str): Represents a numeric data type. (Deprecated in Jan 2025: Use number instead)
boolean (str): Represents a boolean data type.
list (str): Represents a list data type.
object (str): Represents an object data type.
string (str): Represents a string data type. (Deprecated in Jan 2025: Use text instead)
number (str): Represents a number data type.
time (str): Represents a time data type.
date (str): Represents a date data type.
text[] (str): Represents an array of text data type. (Deprecated in Jan 2025)
jsonb (str): Represents a JSONB data type. (Deprecated in Jan 2025)
Note:
Because of upcoming changes, please use `list`, `object`, `text`, `date`, `time`, and `number` going forward.
text, integer, numeric, boolean, list, object, string, number, time, date, text[], jsonb Description of the task to be performed
Type of transformation to be applied.
extraction, classification, generation, manual The default value to use if has_default is true and no value is found in the document. The value you should return is stored under the 'value' key.
If true, use the default value specified in default_value. If false, return null if no value found.
Required when column_type is object or list. Defines the structure of object or list operations. If column_type is list, then operations should only be of length 1 since list can only be of one type. If column_type is object, then operations can be longer of length one (and optionally be nested.)
Name of the column to be transformed. Any alphanumeric characters are allowed. Must be unique.
TransformColumnType is an enumeration that defines various data types for transforming columns.
Attributes:
text (str): Represents a text data type.
integer (str): Represents an integer data type. (Deprecated in Jan 2025: Use number instead)
numeric (str): Represents a numeric data type. (Deprecated in Jan 2025: Use number instead)
boolean (str): Represents a boolean data type.
list (str): Represents a list data type.
object (str): Represents an object data type.
string (str): Represents a string data type. (Deprecated in Jan 2025: Use text instead)
number (str): Represents a number data type.
time (str): Represents a time data type.
date (str): Represents a date data type.
text[] (str): Represents an array of text data type. (Deprecated in Jan 2025)
jsonb (str): Represents a JSONB data type. (Deprecated in Jan 2025)
Note:
Because of upcoming changes, please use `list`, `object`, `text`, `date`, `time`, and `number` going forward.
text, integer, numeric, boolean, list, object, string, number, time, date, text[], jsonb Description of the task to be performed
Type of transformation to be applied.
extraction, classification, generation, manual The default value to use if has_default is true and no value is found in the document. The value you should return is stored under the 'value' key.
If true, use the default value specified in default_value. If false, return null if no value found.
Required when column_type is object or list. Defines the structure of object or list operations. If column_type is list, then operations should only be of length 1 since list can only be of one type. If column_type is object, then operations can be longer of length one (and optionally be nested.)
NOTE: only valid with classification tasks. Output values of the transformation operation.
{
"message": "<string>",
"metadata": {
"total_generated": 123
},
"data": [
{
"column_name": "<string>",
"column_type": "text",
"transform_type": "extraction",
"task_description": "<string>",
"operations": [
{
"column_name": "<string>",
"column_type": "text",
"transform_type": "extraction",
"task_description": "<string>",
"operations": [
{}
],
"output_values": {},
"has_default": true,
"default_value": {}
}
],
"output_values": {},
"has_default": true,
"default_value": {},
"id": "<string>"
}
]
}