Create new Task

POST

api

tasks

create

object

task_type

enum<string>

name

string

input_type

object

output_type

object

examples

array

reference_data

array

prompt

string

directives

object

session_id

string

latency

integer

accuracy

integer

cost

integer

reproducibility

integer

freshness

integer

personalization

integer

recall

integer

creativity

integer

collection_name

string

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

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

array

Examples of expected input and output for the task

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

collection_name

string | null

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

Response

200 - application/json

urn

string

required

href

string

required

Introduction Execute Task

API Documentation

Endpoints

Create new Task

Body

Response