Interface Step

This task can be a question, a prompt, etc. It can include additional parameters and artifacts.

interface Step {
    cost?: number;
    created_at?: Date;
    input_artifacts?: Artifact[];
    input_params?: {
        [name: string]: string;
    }[];
    input_query: string;
    is_last?: boolean;
    name?: string;
    output: any;
    output_additional?: {
        [name: string]: any;
    }[];
    output_artifacts?: any[];
    predecessor?: string;
    retries?: number;
    step_id: string;
    step_status: AgentExecutionStatus;
    task_id: string;
    updated_at?: Date;
}

Hierarchy (view full)

Properties

cost? created_at? input_artifacts? input_params? input_query is_last? name? output output_additional? output_artifacts? predecessor? retries? step_id step_status task_id updated_at?

Properties

Optional cost

cost?: number

The cost in credits resulting from the execution of the task or the step

Optional created_at

created_at?: Date

When the execution was created

Optional input_artifacts

input_artifacts?: Artifact[]

List of artifact ids that are associated with the task

Optional input_params

input_params?: {
    [name: string]: string;
}[]

Additional parameters required for the task

Type declaration

  • [name: string]: string

input_query

input_query: string

The input for the task. It can be a prompt, a question, etc

Optional is_last

is_last?: boolean

Whether this is the last step in the task.

Optional name

name?: string

The name of the step

output

output: any

The main output generated by a task or step

Optional output_additional

output_additional?: {
    [name: string]: any;
}[]

Additional output generated

Type declaration

  • [name: string]: any

Optional output_artifacts

output_artifacts?: any[]

List of artifact generated by the task or step

Optional predecessor

predecessor?: string

The step preceeding the current step if any

Optional retries

retries?: number

The number of retries for the task or step

step_id

step_id: string

The unique identifier of the step

step_status

step_status: AgentExecutionStatus

The status of the execution

task_id

task_id: string

The task that the step belongs to

Optional updated_at

updated_at?: Date

When the execution was last updated

Settings

Member Visibility

Theme

On This Page

costcreated_atinput_artifactsinput_paramsinput_queryis_lastnameoutputoutput_additionaloutput_artifactspredecessorretriesstep_idstep_statustask_idupdated_at