w.knowledge_assistants: KnowledgeAssistants.v1

class databricks.sdk.service.knowledgeassistants.KnowledgeAssistantsAPI

Manage Knowledge Assistants and related resources.

create_example(parent: str, example: Example) → Example

Creates an example for a Knowledge Assistant.

Parameters:

  • parent – str Parent resource where this example will be created. Format: knowledge-assistants/{knowledge_assistant_id}

  • example – Example The example to create under the parent Knowledge Assistant.

Returns:

Example

create_knowledge_assistant(knowledge_assistant: KnowledgeAssistant) → KnowledgeAssistant

Creates a Knowledge Assistant.

Parameters:

knowledge_assistant – KnowledgeAssistant The Knowledge Assistant to create.

Returns:

KnowledgeAssistant

create_knowledge_source(parent: str, knowledge_source: KnowledgeSource) → KnowledgeSource

Creates a Knowledge Source under a Knowledge Assistant.

Parameters:

  • parent – str Parent resource where this source will be created. Format: knowledge-assistants/{knowledge_assistant_id}

  • knowledge_source – KnowledgeSource

Returns:

KnowledgeSource

delete_example(name: str)

Deletes an example from a Knowledge Assistant.

Parameters:

name – str The resource name of the example to delete. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}

delete_knowledge_assistant(name: str)

Deletes a Knowledge Assistant.

Parameters:

name – str The resource name of the knowledge assistant to be deleted. Format: knowledge-assistants/{knowledge_assistant_id}

delete_knowledge_source(name: str)

Deletes a Knowledge Source.

Parameters:

name – str The resource name of the Knowledge Source to delete. Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

get_example(name: str) → Example

Gets an example from a Knowledge Assistant.

Parameters:

name – str The resource name of the example. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}

Returns:

Example

get_knowledge_assistant(name: str) → KnowledgeAssistant

Gets a Knowledge Assistant.

Parameters:

name – str The resource name of the knowledge assistant. Format: knowledge-assistants/{knowledge_assistant_id}

Returns:

KnowledgeAssistant

get_knowledge_source(name: str) → KnowledgeSource

Gets a Knowledge Source.

Parameters:

name – str The resource name of the Knowledge Source. Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

Returns:

KnowledgeSource

get_permission_levels(knowledge_assistant_id: str) → GetKnowledgeAssistantPermissionLevelsResponse

Gets the permission levels that a user can have on an object.

Parameters:

knowledge_assistant_id – str The knowledge assistant for which to get or manage permissions.

Returns:

GetKnowledgeAssistantPermissionLevelsResponse

get_permissions(knowledge_assistant_id: str) → KnowledgeAssistantPermissions

Gets the permissions of a knowledge assistant. Knowledge assistants can inherit permissions from their root object.

Parameters:

knowledge_assistant_id – str The knowledge assistant for which to get or manage permissions.

Returns:

KnowledgeAssistantPermissions

list_examples(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Example]

Lists examples under a Knowledge Assistant.

Parameters:

  • parent – str Parent resource to list from. Format: knowledge-assistants/{knowledge_assistant_id}

  • page_size – int (optional) The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token – str (optional) A page token, received from a previous ListExamples call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

Returns:

Iterator over Example

list_knowledge_assistants([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[KnowledgeAssistant]

List Knowledge Assistants

Parameters:

  • page_size – int (optional) 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.

  • page_token – str (optional) A page token, received from a previous ListKnowledgeAssistants call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

Returns:

Iterator over KnowledgeAssistant

list_knowledge_sources(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[KnowledgeSource]

Lists Knowledge Sources under a Knowledge Assistant.

Parameters:

  • parent – str Parent resource to list from. Format: knowledge-assistants/{knowledge_assistant_id}

  • page_size – int (optional)

  • page_token – str (optional)

Returns:

Iterator over KnowledgeSource

set_permissions(knowledge_assistant_id: str [, access_control_list: Optional[List[KnowledgeAssistantAccessControlRequest]]]) → KnowledgeAssistantPermissions

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

Parameters:
Returns:

KnowledgeAssistantPermissions

sync_knowledge_sources(name: str)

Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources do not require sync)

Parameters:

name – str The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}

update_example(name: str, example: Example, update_mask: FieldMask) → Example

Updates an example in a Knowledge Assistant.

Parameters:

  • name – str The resource name of the example to update. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}

  • example – Example

  • update_mask – FieldMask Comma-delimited list of fields to update on the example. Allowed values: question, guidelines. Examples: - question - question,guidelines

Returns:

Example

update_knowledge_assistant(name: str, knowledge_assistant: KnowledgeAssistant, update_mask: FieldMask) → KnowledgeAssistant

Updates a Knowledge Assistant.

Parameters:

  • name – str The resource name of the Knowledge Assistant. Format: knowledge-assistants/{knowledge_assistant_id}

  • knowledge_assistant – KnowledgeAssistant The Knowledge Assistant update payload. Only fields listed in update_mask are updated. REQUIRED annotations on Knowledge Assistant fields describe create-time requirements and do not mean all those fields are required for update.

  • update_mask – FieldMask Comma-delimited list of fields to update on the Knowledge Assistant. Allowed values: display_name, description, instructions. Examples: - display_name - description,instructions

Returns:

KnowledgeAssistant

update_knowledge_source(name: str, knowledge_source: KnowledgeSource, update_mask: FieldMask) → KnowledgeSource

Updates a Knowledge Source.

Parameters:

  • name – str The resource name of the Knowledge Source to update. Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}

  • knowledge_source – KnowledgeSource The Knowledge Source update payload. Only fields listed in update_mask are updated. REQUIRED annotations on Knowledge Source fields describe create-time requirements and do not mean all those fields are required for update.

  • update_mask – FieldMask Comma-delimited list of fields to update on the Knowledge Source. Allowed values: display_name, description. Examples: - display_name - display_name,description

Returns:

KnowledgeSource

update_permissions(knowledge_assistant_id: str [, access_control_list: Optional[List[KnowledgeAssistantAccessControlRequest]]]) → KnowledgeAssistantPermissions

Updates the permissions on a knowledge assistant. Knowledge assistants can inherit permissions from their root object.

Parameters:
Returns:

KnowledgeAssistantPermissions