1. Packages
  2. Databricks Provider
  3. API Docs
  4. getKnowledgeAssistant
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getKnowledgeAssistant

databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    Using getKnowledgeAssistant

    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 getKnowledgeAssistant(args: GetKnowledgeAssistantArgs, opts?: InvokeOptions): Promise<GetKnowledgeAssistantResult>
function getKnowledgeAssistantOutput(args: GetKnowledgeAssistantOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeAssistantResult>
    def get_knowledge_assistant(name: Optional[str] = None,
                            provider_config: Optional[GetKnowledgeAssistantProviderConfig] = None,
                            opts: Optional[InvokeOptions] = None) -> GetKnowledgeAssistantResult
def get_knowledge_assistant_output(name: Optional[pulumi.Input[str]] = None,
                            provider_config: Optional[pulumi.Input[GetKnowledgeAssistantProviderConfigArgs]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeAssistantResult]
    func LookupKnowledgeAssistant(ctx *Context, args *LookupKnowledgeAssistantArgs, opts ...InvokeOption) (*LookupKnowledgeAssistantResult, error)
func LookupKnowledgeAssistantOutput(ctx *Context, args *LookupKnowledgeAssistantOutputArgs, opts ...InvokeOption) LookupKnowledgeAssistantResultOutput

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

    public static class GetKnowledgeAssistant 
{
    public static Task<GetKnowledgeAssistantResult> InvokeAsync(GetKnowledgeAssistantArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgeAssistantResult> Invoke(GetKnowledgeAssistantInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKnowledgeAssistantResult> getKnowledgeAssistant(GetKnowledgeAssistantArgs args, InvokeOptions options)
public static Output<GetKnowledgeAssistantResult> getKnowledgeAssistant(GetKnowledgeAssistantArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getKnowledgeAssistant:getKnowledgeAssistant
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    ProviderConfig GetKnowledgeAssistantProviderConfig
    Configure the provider for management through account provider.
    Name string
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    ProviderConfig GetKnowledgeAssistantProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    providerConfig GetKnowledgeAssistantProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    providerConfig GetKnowledgeAssistantProviderConfig
    Configure the provider for management through account provider.
    name str
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    provider_config GetKnowledgeAssistantProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getKnowledgeAssistant Result

    The following output properties are available:

    CreateTime string
    (string) - Creation timestamp
    Creator string
    (string) - The creator of the Knowledge Assistant
    Description string
    (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
    (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
    (string) - The name of the knowledge assistant agent endpoint
    ErrorInfo string
    (string) - Error details when the Knowledge Assistant is in FAILED state
    ExperimentId string
    (string) - The MLflow experiment ID
    Id string
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    Instructions string
    (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
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    State string
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    ProviderConfig GetKnowledgeAssistantProviderConfig
    CreateTime string
    (string) - Creation timestamp
    Creator string
    (string) - The creator of the Knowledge Assistant
    Description string
    (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
    (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
    (string) - The name of the knowledge assistant agent endpoint
    ErrorInfo string
    (string) - Error details when the Knowledge Assistant is in FAILED state
    ExperimentId string
    (string) - The MLflow experiment ID
    Id string
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    Instructions string
    (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
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    State string
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    ProviderConfig GetKnowledgeAssistantProviderConfig
    createTime String
    (string) - Creation timestamp
    creator String
    (string) - The creator of the Knowledge Assistant
    description String
    (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
    (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
    (string) - The name of the knowledge assistant agent endpoint
    errorInfo String
    (string) - Error details when the Knowledge Assistant is in FAILED state
    experimentId String
    (string) - The MLflow experiment ID
    id String
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    instructions String
    (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
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    state String
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    providerConfig GetKnowledgeAssistantProviderConfig
    createTime string
    (string) - Creation timestamp
    creator string
    (string) - The creator of the Knowledge Assistant
    description string
    (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
    (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
    (string) - The name of the knowledge assistant agent endpoint
    errorInfo string
    (string) - Error details when the Knowledge Assistant is in FAILED state
    experimentId string
    (string) - The MLflow experiment ID
    id string
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    instructions string
    (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
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    state string
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    providerConfig GetKnowledgeAssistantProviderConfig
    create_time str
    (string) - Creation timestamp
    creator str
    (string) - The creator of the Knowledge Assistant
    description str
    (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
    display_name str
    (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
    endpoint_name str
    (string) - The name of the knowledge assistant agent endpoint
    error_info str
    (string) - Error details when the Knowledge Assistant is in FAILED state
    experiment_id str
    (string) - The MLflow experiment ID
    id str
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    instructions str
    (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 str
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    state str
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    provider_config GetKnowledgeAssistantProviderConfig
    createTime String
    (string) - Creation timestamp
    creator String
    (string) - The creator of the Knowledge Assistant
    description String
    (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
    (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
    (string) - The name of the knowledge assistant agent endpoint
    errorInfo String
    (string) - Error details when the Knowledge Assistant is in FAILED state
    experimentId String
    (string) - The MLflow experiment ID
    id String
    (string) - The universally unique identifier (UUID) of the Knowledge Assistant
    instructions String
    (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
    (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
    state String
    (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED
    providerConfig Property Map

    Supporting Types

    GetKnowledgeAssistantProviderConfig

    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
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.