Databricks SDK for JavaScript
    Preparing search index...

    Interface KnowledgeSource

    KnowledgeSource represents a source of knowledge for the KnowledgeAssistant. Used in create/update requests and returned in Get/List responses. Note: REQUIRED annotations below represent create-time requirements. For updates, required fields are determined by the update mask.

    interface KnowledgeSource {
        createTime?: Instant;
        description?: string;
        displayName?: string;
        id?: string;
        knowledgeCutoffTime?: Instant;
        name?: string;
        sourceType?: string;
        spec?:
            | { $case: "index"; index: IndexSpec }
            | { $case: "files"; files: FilesSpec }
            | { $case: "fileTable"; fileTable: FileTableSpec };
        state?: KnowledgeSource_State;
    }
    Index

    Properties

    createTime? description? displayName? id? knowledgeCutoffTime? name? sourceType? spec? state?

    Properties

    createTime?: Instant

    Timestamp when this knowledge source was created.

    description?: string

    Description of the knowledge source. Required when creating a Knowledge Source. When updating a Knowledge Source, optional unless included in update_mask.

    displayName?: string

    Human-readable display name of the knowledge source. Required when creating a Knowledge Source. When updating a Knowledge Source, optional unless included in update_mask.

    id?: string
    knowledgeCutoffTime?: Instant

    Timestamp representing the cutoff before which content in this knowledge source is being ingested.

    name?: string

    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

    sourceType?: string

    The type of the source: "index", "files", or "file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored.

    spec?:
        | { $case: "index"; index: IndexSpec }
        | { $case: "files"; files: FilesSpec }
        | { $case: "fileTable"; fileTable: FileTableSpec }

    Specification for the knowledge source type.

    state?: KnowledgeSource_State

    Settings

    Member Visibility

    On This Page

    Properties