Bluestep JS Documentation
    Preparing search index...

    Interface AiToolForExistingEntryOptions

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

    interface AiToolForExistingEntryOptions {
        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 the entry. Use for derived state the model can't produce — e.g. signing a signature field with the current time.

    description?: string

    Tool description sent to the model. Defaults to "Update fields on the

    entry."

    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[]

    JSON-Schema required array. Default: empty — for an existing entry the model only supplies the fields it intends to change.

    Settings

    Member Visibility

    On This Page

    experimental