@squidcloud/client
    Preparing search index...

    Interface AiFunctionMetadata

    Metadata describing an AI function available in the application.

    interface AiFunctionMetadata {
        attributes?: AiFunctionAttributes;
        categories?: string[];
        description?: string;
        internal?: boolean;
        params: AiFunctionParam[];
        promptId?: string;
        serviceFunction: `${string}:${string}`;
    }
    Index

    Properties

    attributes? categories? description? internal? params promptId? serviceFunction

    Properties

    attributes?: AiFunctionAttributes

    Additional attributes for the function.

    categories?: string[]

    Categories this function belongs to.

    description?: string

    Description of what the function does. Optional when promptId is set, in which case the description is resolved server-side from the prompt registry at the point the LLM tool definition is built.

    internal?: boolean

    Whether this function is internal and not meant for direct use.

    params: AiFunctionParam[]

    Parameters that the function accepts.

    promptId?: string

    Opaque id of a registered prompt that supplies this function's description. Stored verbatim (the public SDK never resolves it — that would ship the internal prompt registry to customers); resolution happens server-side.

    serviceFunction: `${string}:${string}`

    The fully qualified name of the function (serviceName:functionName).

    Settings

    Member Visibility

    On This Page

    Properties