Tela SDK for JavaScript
    Preparing search index...

    Interface CanvasOptions<TInput, TOutput>

    interface CanvasOptions<TInput, TOutput> {
        applicationId?: string;
        client: BaseClient;
        id?: string;
        input?: SchemaFunction<TInput>;
        isWorkflow: boolean;
        name?: string;
        output?: SchemaFunction<TOutput>;
        variables: CanvasVariable[];
        versionId?: string;
    }

    Type Parameters

    • TInput
    • TOutput
    Index

    Properties

    applicationId? client id? input? isWorkflow name? output? variables versionId?

    Properties

    applicationId?: string

    Id of the application that the canvas belongs to.

    client: BaseClient

    Base client for making requests to the Tela API.

    id?: string

    Id of the canvas that will be used to create the completion.

    input?: SchemaFunction<TInput>

    Input schema of the canvas.

    isWorkflow: boolean

    Whether the canvas is a workflow.

    name?: string

    Name of the canvas. Useful for debugging.

    output?: SchemaFunction<TOutput>

    Output schema of the canvas.

    variables: CanvasVariable[]

    Variables of the canvas.

    versionId?: string

    Id of the version of the canvas. If not provided, the latest promoted version will be used.

    Settings

    Member Visibility

    On This Page

    Properties