1. Packages
  2. Databricks Provider
  3. API Docs
  4. getKnowledgeAssistantKnowledgeSource
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

    Public Beta

    Using getKnowledgeAssistantKnowledgeSource

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKnowledgeAssistantKnowledgeSource(args: GetKnowledgeAssistantKnowledgeSourceArgs, opts?: InvokeOptions): Promise<GetKnowledgeAssistantKnowledgeSourceResult>
    function getKnowledgeAssistantKnowledgeSourceOutput(args: GetKnowledgeAssistantKnowledgeSourceOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeAssistantKnowledgeSourceResult>
    def get_knowledge_assistant_knowledge_source(name: Optional[str] = None,
                                                 provider_config: Optional[GetKnowledgeAssistantKnowledgeSourceProviderConfig] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetKnowledgeAssistantKnowledgeSourceResult
    def get_knowledge_assistant_knowledge_source_output(name: Optional[pulumi.Input[str]] = None,
                                                 provider_config: Optional[pulumi.Input[GetKnowledgeAssistantKnowledgeSourceProviderConfigArgs]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeAssistantKnowledgeSourceResult]
    func LookupKnowledgeAssistantKnowledgeSource(ctx *Context, args *LookupKnowledgeAssistantKnowledgeSourceArgs, opts ...InvokeOption) (*LookupKnowledgeAssistantKnowledgeSourceResult, error)
    func LookupKnowledgeAssistantKnowledgeSourceOutput(ctx *Context, args *LookupKnowledgeAssistantKnowledgeSourceOutputArgs, opts ...InvokeOption) LookupKnowledgeAssistantKnowledgeSourceResultOutput

    > Note: This function is named LookupKnowledgeAssistantKnowledgeSource in the Go SDK.

    public static class GetKnowledgeAssistantKnowledgeSource 
    {
        public static Task<GetKnowledgeAssistantKnowledgeSourceResult> InvokeAsync(GetKnowledgeAssistantKnowledgeSourceArgs args, InvokeOptions? opts = null)
        public static Output<GetKnowledgeAssistantKnowledgeSourceResult> Invoke(GetKnowledgeAssistantKnowledgeSourceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKnowledgeAssistantKnowledgeSourceResult> getKnowledgeAssistantKnowledgeSource(GetKnowledgeAssistantKnowledgeSourceArgs args, InvokeOptions options)
    public static Output<GetKnowledgeAssistantKnowledgeSourceResult> getKnowledgeAssistantKnowledgeSource(GetKnowledgeAssistantKnowledgeSourceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getKnowledgeAssistantKnowledgeSource:getKnowledgeAssistantKnowledgeSource
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    ProviderConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    Configure the provider for management through account provider.
    Name string
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    ProviderConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    Configure the provider for management through account provider.
    name String
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    providerConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    Configure the provider for management through account provider.
    name string
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    providerConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    Configure the provider for management through account provider.
    name str
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    provider_config GetKnowledgeAssistantKnowledgeSourceProviderConfig
    Configure the provider for management through account provider.
    name String
    Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getKnowledgeAssistantKnowledgeSource Result

    The following output properties are available:

    CreateTime string
    (string) - Timestamp when this knowledge source was created
    Description string
    (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
    (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
    FileTable GetKnowledgeAssistantKnowledgeSourceFileTable
    (FileTableSpec)
    Files GetKnowledgeAssistantKnowledgeSourceFiles
    (FilesSpec)
    Id string
    (string)
    Index GetKnowledgeAssistantKnowledgeSourceIndex
    (IndexSpec)
    KnowledgeCutoffTime string
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    Name string
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    SourceType string
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    State string
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    ProviderConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    CreateTime string
    (string) - Timestamp when this knowledge source was created
    Description string
    (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
    (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
    FileTable GetKnowledgeAssistantKnowledgeSourceFileTable
    (FileTableSpec)
    Files GetKnowledgeAssistantKnowledgeSourceFiles
    (FilesSpec)
    Id string
    (string)
    Index GetKnowledgeAssistantKnowledgeSourceIndex
    (IndexSpec)
    KnowledgeCutoffTime string
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    Name string
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    SourceType string
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    State string
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    ProviderConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    createTime String
    (string) - Timestamp when this knowledge source was created
    description String
    (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
    (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
    fileTable GetKnowledgeAssistantKnowledgeSourceFileTable
    (FileTableSpec)
    files GetKnowledgeAssistantKnowledgeSourceFiles
    (FilesSpec)
    id String
    (string)
    index GetKnowledgeAssistantKnowledgeSourceIndex
    (IndexSpec)
    knowledgeCutoffTime String
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    name String
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    sourceType String
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    state String
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    providerConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    createTime string
    (string) - Timestamp when this knowledge source was created
    description string
    (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
    (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
    fileTable GetKnowledgeAssistantKnowledgeSourceFileTable
    (FileTableSpec)
    files GetKnowledgeAssistantKnowledgeSourceFiles
    (FilesSpec)
    id string
    (string)
    index GetKnowledgeAssistantKnowledgeSourceIndex
    (IndexSpec)
    knowledgeCutoffTime string
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    name string
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    sourceType string
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    state string
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    providerConfig GetKnowledgeAssistantKnowledgeSourceProviderConfig
    create_time str
    (string) - Timestamp when this knowledge source was created
    description str
    (string) - Description of the knowledge source. Required when creating a Knowledge Source. When updating a Knowledge Source, optional unless included in update_mask
    display_name str
    (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
    file_table GetKnowledgeAssistantKnowledgeSourceFileTable
    (FileTableSpec)
    files GetKnowledgeAssistantKnowledgeSourceFiles
    (FilesSpec)
    id str
    (string)
    index GetKnowledgeAssistantKnowledgeSourceIndex
    (IndexSpec)
    knowledge_cutoff_time str
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    name str
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    source_type str
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    state str
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    provider_config GetKnowledgeAssistantKnowledgeSourceProviderConfig
    createTime String
    (string) - Timestamp when this knowledge source was created
    description String
    (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
    (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
    fileTable Property Map
    (FileTableSpec)
    files Property Map
    (FilesSpec)
    id String
    (string)
    index Property Map
    (IndexSpec)
    knowledgeCutoffTime String
    (string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested
    name String
    (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
    sourceType String
    (string) - The type of the source: "index", "files", or <span pulumi-lang-nodejs=""fileTable"" pulumi-lang-dotnet=""FileTable"" pulumi-lang-go=""fileTable"" pulumi-lang-python=""file_table"" pulumi-lang-yaml=""fileTable"" pulumi-lang-java=""fileTable"">"file_table". Required when creating a Knowledge Source. When updating a Knowledge Source, this field is ignored
    state String
    (string) - Possible values are: FAILED_UPDATE, UPDATED, UPDATING
    providerConfig Property Map

    Supporting Types

    GetKnowledgeAssistantKnowledgeSourceFileTable

    FileCol string
    (string) - The name of the column containing BINARY file content to be indexed
    TableName string
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}
    FileCol string
    (string) - The name of the column containing BINARY file content to be indexed
    TableName string
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}
    fileCol String
    (string) - The name of the column containing BINARY file content to be indexed
    tableName String
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}
    fileCol string
    (string) - The name of the column containing BINARY file content to be indexed
    tableName string
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}
    file_col str
    (string) - The name of the column containing BINARY file content to be indexed
    table_name str
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}
    fileCol String
    (string) - The name of the column containing BINARY file content to be indexed
    tableName String
    (string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}

    GetKnowledgeAssistantKnowledgeSourceFiles

    Path string
    (string) - A UC volume path that includes a list of files
    Path string
    (string) - A UC volume path that includes a list of files
    path String
    (string) - A UC volume path that includes a list of files
    path string
    (string) - A UC volume path that includes a list of files
    path str
    (string) - A UC volume path that includes a list of files
    path String
    (string) - A UC volume path that includes a list of files

    GetKnowledgeAssistantKnowledgeSourceIndex

    DocUriCol string
    (string) - The column that specifies a link or reference to where the information came from
    IndexName string
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    TextCol string
    (string) - The column that includes the document text for retrieval
    DocUriCol string
    (string) - The column that specifies a link or reference to where the information came from
    IndexName string
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    TextCol string
    (string) - The column that includes the document text for retrieval
    docUriCol String
    (string) - The column that specifies a link or reference to where the information came from
    indexName String
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    textCol String
    (string) - The column that includes the document text for retrieval
    docUriCol string
    (string) - The column that specifies a link or reference to where the information came from
    indexName string
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    textCol string
    (string) - The column that includes the document text for retrieval
    doc_uri_col str
    (string) - The column that specifies a link or reference to where the information came from
    index_name str
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    text_col str
    (string) - The column that includes the document text for retrieval
    docUriCol String
    (string) - The column that specifies a link or reference to where the information came from
    indexName String
    (string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}
    textCol String
    (string) - The column that includes the document text for retrieval

    GetKnowledgeAssistantKnowledgeSourceProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.