@squidcloud/backend
    Preparing search index...

    Interface AiFunctionMetadataOptions

    Options for the @aiFunction annotation.

    interface AiFunctionMetadataOptions {
        attributes?: AiFunctionAttributes;
        categories?: string[];
        description: string;
        id?: string;
        internal?: boolean;
        params: AiFunctionParam[];
    }
    Index

    Properties

    attributes? categories? description id? internal? params

    Properties

    attributes?: AiFunctionAttributes

    Additional optional attributes for the function. Example: related integrations.

    categories?: string[]

    The categories this function is associated with.

    Can be many or none. If no categories are specified, then the function is lumped into a default category.

    The Studio will group the functions into the categories for easier discovery.

    If multiple categories are given, the function will appear once in each category section in the Studio.

    description: string

    Describes the capabilities of the function. This is used by the AI agent to determine when to call it.

    id?: string

    Unique AI function ID. If not set, the function name (excluding the class name) is used as the default ID. If not provided the ID of the function is constructed as 'ClassName:FunctionName'.

    internal?: boolean

    Mark the function as internal-only. Hides the function from appearing in the Studio.

    params: AiFunctionParam[]

    Parameters for the AI function. These parameters are passed to the function by the calling agent.

    Settings

    Member Visibility

    On This Page

    Properties