databricks.KnowledgeAssistant

Databricks v1.90.0, Mar 19 26

Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Create KnowledgeAssistant Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new KnowledgeAssistant(name: string, args: KnowledgeAssistantArgs, opts?: CustomResourceOptions);

@overload
def KnowledgeAssistant(resource_name: str,
                       args: KnowledgeAssistantArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def KnowledgeAssistant(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       instructions: Optional[str] = None,
                       provider_config: Optional[KnowledgeAssistantProviderConfigArgs] = None)

func NewKnowledgeAssistant(ctx *Context, name string, args KnowledgeAssistantArgs, opts ...ResourceOption) (*KnowledgeAssistant, error)

public KnowledgeAssistant(string name, KnowledgeAssistantArgs args, CustomResourceOptions? opts = null)

public KnowledgeAssistant(String name, KnowledgeAssistantArgs args)
public KnowledgeAssistant(String name, KnowledgeAssistantArgs args, CustomResourceOptions options)

type: databricks:KnowledgeAssistant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KnowledgeAssistantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args KnowledgeAssistantArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KnowledgeAssistantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KnowledgeAssistantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args KnowledgeAssistantArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var knowledgeAssistantResource = new Databricks.Index.KnowledgeAssistant("knowledgeAssistantResource", new()
{
    Description = "string",
    DisplayName = "string",
    Instructions = "string",
    ProviderConfig = new Databricks.Inputs.KnowledgeAssistantProviderConfigArgs
    {
        WorkspaceId = "string",
    },
});

example, err := databricks.NewKnowledgeAssistant(ctx, "knowledgeAssistantResource", &databricks.KnowledgeAssistantArgs{
	Description:  pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Instructions: pulumi.String("string"),
	ProviderConfig: &databricks.KnowledgeAssistantProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
})

var knowledgeAssistantResource = new KnowledgeAssistant("knowledgeAssistantResource", KnowledgeAssistantArgs.builder()
    .description("string")
    .displayName("string")
    .instructions("string")
    .providerConfig(KnowledgeAssistantProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .build());

knowledge_assistant_resource = databricks.KnowledgeAssistant("knowledgeAssistantResource",
    description="string",
    display_name="string",
    instructions="string",
    provider_config={
        "workspace_id": "string",
    })

const knowledgeAssistantResource = new databricks.KnowledgeAssistant("knowledgeAssistantResource", {
    description: "string",
    displayName: "string",
    instructions: "string",
    providerConfig: {
        workspaceId: "string",
    },
});

type: databricks:KnowledgeAssistant
properties:
    description: string
    displayName: string
    instructions: string
    providerConfig:
        workspaceId: string

KnowledgeAssistant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The KnowledgeAssistant resource accepts the following input properties:

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
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
ProviderConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.

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
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
ProviderConfig KnowledgeAssistantProviderConfigArgs: Configure the provider for management through account provider.

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
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
providerConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.

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
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
providerConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.

description str: 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: 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
instructions str: 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
provider_config KnowledgeAssistantProviderConfigArgs: Configure the provider for management through account provider.

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
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
providerConfig Property Map: Configure the provider for management through account provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the KnowledgeAssistant resource produces the following output properties:

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

CreateTime string: (string) - Creation timestamp
Creator string: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

createTime string: (string) - Creation timestamp
creator string: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

create_time str: (string) - Creation timestamp
creator str: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

createTime String: (string) - Creation timestamp
creator String: (string) - The creator of the Knowledge Assistant
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: The provider-assigned unique ID for this managed resource.
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

Look up Existing KnowledgeAssistant Resource

Get an existing KnowledgeAssistant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KnowledgeAssistantState, opts?: CustomResourceOptions): KnowledgeAssistant

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        creator: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        error_info: Optional[str] = None,
        experiment_id: Optional[str] = None,
        instructions: Optional[str] = None,
        name: Optional[str] = None,
        provider_config: Optional[KnowledgeAssistantProviderConfigArgs] = None,
        state: Optional[str] = None) -> KnowledgeAssistant

func GetKnowledgeAssistant(ctx *Context, name string, id IDInput, state *KnowledgeAssistantState, opts ...ResourceOption) (*KnowledgeAssistant, error)

public static KnowledgeAssistant Get(string name, Input<string> id, KnowledgeAssistantState? state, CustomResourceOptions? opts = null)

public static KnowledgeAssistant get(String name, Output<String> id, KnowledgeAssistantState state, CustomResourceOptions options)

resources:  _:    type: databricks:KnowledgeAssistant    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreateTime string: (string) - Creation timestamp
Creator string: (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: (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
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: (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
ProviderConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.
State string: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

CreateTime string: (string) - Creation timestamp
Creator string: (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: (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
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: (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
ProviderConfig KnowledgeAssistantProviderConfigArgs: Configure the provider for management through account provider.
State string: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

createTime String: (string) - Creation timestamp
creator String: (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: (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
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: (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
providerConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.
state String: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

createTime string: (string) - Creation timestamp
creator string: (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: (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
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: (string) - The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}
providerConfig KnowledgeAssistantProviderConfig: Configure the provider for management through account provider.
state string: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

create_time str: (string) - Creation timestamp
creator str: (string) - The creator of the Knowledge Assistant
description str: 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: 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
instructions str: 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}
provider_config KnowledgeAssistantProviderConfigArgs: Configure the provider for management through account provider.
state str: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

createTime String: (string) - Creation timestamp
creator String: (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: (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
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: (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.
state String: (string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: ACTIVE, CREATING, FAILED

Supporting Types

KnowledgeAssistantProviderConfig, KnowledgeAssistantProviderConfigArgs

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.

Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

databricks.KnowledgeAssistant

On this page

On this page

Create KnowledgeAssistant Resource

Constructor syntax

Parameters

Constructor example

KnowledgeAssistant Resource Properties

Inputs

Outputs

Look up Existing KnowledgeAssistant Resource

Supporting Types

KnowledgeAssistantProviderConfig, KnowledgeAssistantProviderConfigArgs

Package Details

On this page

On this page