Databricks SDK for JavaScript
    Preparing search index...

    Interface GenieAgent

    A Genie Agent resource.

    interface GenieAgent {
        createTime?: Instant;
        definition?: GenieAgentDefinition;
        description?: string;
        displayName?: string;
        effectiveParentPath?: string;
        etag?: string;
        name?: string;
        parentPath?: string;
        updateTime?: Instant;
        warehouseId?: string;
    }
    Index

    Properties

    createTime? definition? description? displayName? effectiveParentPath? etag? name? parentPath? updateTime? warehouseId?

    Properties

    createTime?: Instant

    Time when the Genie Agent was created.

    definition?: GenieAgentDefinition

    The definition of the Genie Agent: its sample questions, data sources, instructions, and benchmarks. Must set at least one field. Returned on get and on list with GENIE_AGENT_VIEW_FULL. Create and update return a submitted definition unchanged; one the service would store differently, or with a column config the workspace can't keep (unknown column, or a display name while those are disabled), is rejected with INVALID_PARAMETER_VALUE.

    description?: string

    Description of the Genie Agent.

    The maximum length is 4,096 characters. Requests with a longer value are rejected with INVALID_PARAMETER_VALUE.

    displayName?: string

    Display name of the Genie Agent. Must be unique within its folder (effective_parent_path): a create, rename, or move that would collide with an existing Genie Agent's name in the target folder is rejected with ALREADY_EXISTS.

    The maximum length is 63 characters. Requests with a longer value are rejected with INVALID_PARAMETER_VALUE.

    effectiveParentPath?: string

    The workspace folder that contains the Genie Agent.

    etag?: string

    Weak etag of definition only; metadata changes do not affect it. Send it on update or delete to detect concurrent definition changes.

    name?: string

    The resource name of the Genie Agent, in the form agents/{genie_agent_id}. Ignored on create.

    parentPath?: string

    The workspace folder to create the Genie Agent in. If omitted, the caller's home folder is used. Returned exactly as submitted; see effective_parent_path for the current folder. On update, setting it moves the Genie Agent and clearing it does not. At most 4,096 characters.

    updateTime?: Instant

    Time when the Genie Agent was last modified.

    warehouseId?: string

    Warehouse associated with the Genie Agent.

    Settings

    Member Visibility

    On This Page

    Properties