Databricks SDK for JavaScript
    Preparing search index...

    Interface KnowledgeAssistant

    Entity message that represents a knowledge assistant. Note: REQUIRED annotations below represent create-time requirements. For updates, required fields are determined by the update mask.

    interface KnowledgeAssistant {
        createTime?: Instant;
        creator?: string;
        description?: string;
        displayName?: string;
        endpointName?: string;
        errorInfo?: string;
        experimentId?: string;
        id?: string;
        instructions?: string;
        name?: string;
        state?: KnowledgeAssistant_State;
    }
    Index

    Properties

    createTime? creator? description? displayName? endpointName? errorInfo? experimentId? id? instructions? name? state?

    Properties

    createTime?: Instant

    Creation timestamp.

    creator?: string

    The creator of the Knowledge Assistant.

    description?: string

    Description of what this agent can do (user-facing). Required when creating a Knowledge Assistant. When updating a Knowledge Assistant, optional unless included in update_mask.

    displayName?: string

    The display name of the Knowledge Assistant, unique at workspace level. Required when creating a Knowledge Assistant. When updating a Knowledge Assistant, optional unless included in update_mask.

    endpointName?: string

    The name of the knowledge assistant agent endpoint.

    errorInfo?: string

    Error details when the Knowledge Assistant is in FAILED state.

    experimentId?: string

    The MLflow experiment ID.

    id?: string

    Deprecated: use knowledge_assistant_id instead.

    instructions?: string

    Additional global instructions on how the agent should generate answers. Optional on create and update. When updating a Knowledge Assistant, include this field in update_mask to modify it.

    name?: string

    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}

    state?: KnowledgeAssistant_State

    State of the Knowledge Assistant. Not returned in List responses.

    Settings

    Member Visibility

    On This Page

    Properties