Bluestep JS Documentation
    Preparing search index...

    Interface AiToolForNewEntryOptions

    Options for B.ai.tool.forNewEntry(). All fields are optional.

    interface AiToolForNewEntryOptions {
        afterApply?: (entry: FormEntry, args: any) => void;
        description?: string;
        exclude?: string[];
        include?: string[];
        name?: string;
        required?: string[];
    }
    Index

    experimental

    afterApply? description? exclude? include? name? required?

    experimental

    afterApply?: (entry: FormEntry, args: any) => void

    Hook invoked after the executor has set field values on a fresh entry. Use for derived state the model can't produce — e.g. signing a signature field.

    description?: string

    Tool description sent to the model. Defaults to "Create a new entry on the

    form."

    exclude?: string[]

    Exclude these field formula IDs from the tool's input schema.

    include?: string[]

    Restrict the tool's input schema to these field formula IDs. Default: every eligible field on the form.

    name?: string

    Tool name. Defaults to a sanitized form display name. Must be unique within a single B.ai.call invocation.

    required?: string[]

    Override the required-field list in the input schema. Default: every included field that has no defaultValue.

    Settings

    Member Visibility

    On This Page

    experimental