Tela SDK for JavaScript
    Preparing search index...

    Interface BaseExecutionParams

    interface BaseExecutionParams {
        applicationId?: string;
        canvasId?: string;
        label?: string;
        messages?: { content: string; role: string }[];
        override?: {
            functions?: {
                description?: string;
                id: string;
                name: string;
                parameters?: {
                    properties: Record<string, unknown>;
                    required?: string[];
                    type: "object";
                };
            }[];
            model?: string;
            temperature?: number;
            type: "chat"
            | "completion";
        };
        skipResultValidation?: boolean;
        tags?: string[];
        versionId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    applicationId? canvasId? label? messages? override? skipResultValidation? tags? versionId?

    Properties

    applicationId?: string

    The ID of the deployed application to use for this chat completion. This is required if a canvasId is not provided.

    canvasId?: string

    The ID of the canvas to use for this chat completion. This is required if an applicationId is not provided.

    label?: string

    Optional label for this execution when using applicationId. This label can be used to identify or categorize the execution. Note: This field is only applicable when applicationId is provided.

    messages?: { content: string; role: string }[]

    An array of previous messages in the conversation. Each message should have a 'role' (e.g., 'user', 'assistant') and 'content'.

    override?: {
        functions?: {
            description?: string;
            id: string;
            name: string;
            parameters?: {
                properties: Record<string, unknown>;
                required?: string[];
                type: "object";
            };
        }[];
        model?: string;
        temperature?: number;
        type: "chat"
        | "completion";
    }

    Override default settings specified in the canvas. This allows for fine-tuning the completion behavior for this specific request.

    Type Declaration

    • Optionalfunctions?: {
          description?: string;
          id: string;
          name: string;
          parameters?: {
              properties: Record<string, unknown>;
              required?: string[];
              type: "object";
          };
      }[]

      An array of functions that the model can call. This allows for more structured and interactive completions.

    • Optionalmodel?: string

      The specific model to use for this completion. If not specified, the default model set in the canvas will be used.

    • Optionaltemperature?: number

      Controls randomness in the output. Values between 0 and 1. Lower values make the output more focused and deterministic.

    • type: "chat" | "completion"

      Specifies whether to use a chat or completion model.

    skipResultValidation?: boolean

    Whether to skip Zod schema validation on execution results. When true, results are typecast to the expected output type without validation.

    false
    tags?: string[]

    Optional array of tags to associate with this execution. Tags can be used for filtering, categorization, and analytics.

    versionId?: string

    The version ID of the canvas to use for this chat completion. If not provided, the latest version of the specified canvas will be used.

    Settings

    Member Visibility

    On This Page

    Properties