Create new Task

Create a new Task using the following information:

Creation will fail if an existing task with the same name and type already exists.

Not all tasks types support all the fields, see each task documentation for more details.

Body

application/json

task_type · enum<string> · required

The task you want to perform

Available options:

transform_with_ref_data,

extract,

transform,

recommend,

ingest_reference_data,

ingest_document,

text_to_text,

index_document

name · string · required

The unique name of the task

Examples:

"recommend-meal-with-preferences"

input_type · object | null

A json schema describing the input type for requests to the task

output_type · object | null

The output type for requests to the task

examples · any[][]

Examples of expected input and output for the task

Show child attributes

any[]

Required array length: 2 elements

reference_data · string[]

The data sources that should be used as reference data for the task

prompt · string | null

The prompt for the task

directives · object | null

The default directives to be applied when running the task

Show child attributes

collection_name · string | null

The name of the collection to use if this task end up creating one

Response

200

application/json

Successful Response

urn · string · required

href · string · required