Interface AiAction

interface AiAction {
    configuration: Configuration;
    description: string;
    instruction: Instruction;
    name: string;
    sys: MetaSysProps & {
        createdAt: string;
        createdBy: Link<"User"> | Link<"AppDefinition">;
        id: string;
        publishedAt?: string;
        publishedBy?: Link<"User"> | Link<"AppDefinition">;
        publishedVersion?: number;
        space: {
            sys: {
                id: string;
            };
        };
        type: "AiAction";
        updatedAt: string;
        updatedBy: Link<"User"> | Link<"AppDefinition">;
        version: number;
    };
    testCases?: AiActionTestCase[];
    delete(): Promise<void>;
    invoke(environmentId: string, payload: AiActionInvocationType): Promise<AiActionInvocation>;
    publish(): Promise<AiAction>;
    toPlainObject(): AiActionProps;
    unpublish(): Promise<AiAction>;
    update(): Promise<AiAction>;
}

Hierarchy (view full)

Properties

configuration description instruction name sys testCases?

Methods

delete invoke publish toPlainObject unpublish update

Properties

configuration

configuration: Configuration

description

description: string

instruction

instruction: Instruction

name

name: string

sys

sys: MetaSysProps & {
    createdAt: string;
    createdBy: Link<"User"> | Link<"AppDefinition">;
    id: string;
    publishedAt?: string;
    publishedBy?: Link<"User"> | Link<"AppDefinition">;
    publishedVersion?: number;
    space: {
        sys: {
            id: string;
        };
    };
    type: "AiAction";
    updatedAt: string;
    updatedBy: Link<"User"> | Link<"AppDefinition">;
    version: number;
}

OptionaltestCases

testCases?: AiActionTestCase[]

Methods

delete

invoke

publish

toPlainObject

unpublish

update

Settings

Member Visibility

On This Page

Properties
Methods