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

databricks.getKnowledgeAssistants

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 getKnowledgeAssistants

    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 getKnowledgeAssistants(args: GetKnowledgeAssistantsArgs, opts?: InvokeOptions): Promise<GetKnowledgeAssistantsResult>
function getKnowledgeAssistantsOutput(args: GetKnowledgeAssistantsOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeAssistantsResult>
    def get_knowledge_assistants(page_size: Optional[int] = None,
                             provider_config: Optional[GetKnowledgeAssistantsProviderConfig] = None,
                             opts: Optional[InvokeOptions] = None) -> GetKnowledgeAssistantsResult
def get_knowledge_assistants_output(page_size: Optional[pulumi.Input[int]] = None,
                             provider_config: Optional[pulumi.Input[GetKnowledgeAssistantsProviderConfigArgs]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeAssistantsResult]
    func GetKnowledgeAssistants(ctx *Context, args *GetKnowledgeAssistantsArgs, opts ...InvokeOption) (*GetKnowledgeAssistantsResult, error)
func GetKnowledgeAssistantsOutput(ctx *Context, args *GetKnowledgeAssistantsOutputArgs, opts ...InvokeOption) GetKnowledgeAssistantsResultOutput

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

    public static class GetKnowledgeAssistants 
{
    public static Task<GetKnowledgeAssistantsResult> InvokeAsync(GetKnowledgeAssistantsArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgeAssistantsResult> Invoke(GetKnowledgeAssistantsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKnowledgeAssistantsResult> getKnowledgeAssistants(GetKnowledgeAssistantsArgs args, InvokeOptions options)
public static Output<GetKnowledgeAssistantsResult> getKnowledgeAssistants(GetKnowledgeAssistantsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PageSize int
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    ProviderConfig GetKnowledgeAssistantsProviderConfig
    Configure the provider for management through account provider.
    PageSize int
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    ProviderConfig GetKnowledgeAssistantsProviderConfig
    Configure the provider for management through account provider.
    pageSize Integer
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig GetKnowledgeAssistantsProviderConfig
    Configure the provider for management through account provider.
    pageSize number
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig GetKnowledgeAssistantsProviderConfig
    Configure the provider for management through account provider.
    page_size int
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    provider_config GetKnowledgeAssistantsProviderConfig
    Configure the provider for management through account provider.
    pageSize Number
    The maximum number of knowledge assistants to return. If unspecified, at most 100 knowledge assistants will be returned. The maximum value is 100; values above 100 will be coerced to 100
    providerConfig Property Map
    Configure the provider for management through account provider.

    getKnowledgeAssistants Result

    The following output properties are available:

    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeAssistants List<Property Map>
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetKnowledgeAssistantsKnowledgeAssistant

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

    GetKnowledgeAssistantsKnowledgeAssistantProviderConfig

    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.

    GetKnowledgeAssistantsProviderConfig

    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.