com.databricks.sdk.service.knowledgeassistants

Class KnowledgeAssistantsAPI

java.lang.Object

com.databricks.sdk.service.knowledgeassistants.KnowledgeAssistantsAPI

@Generated
public class KnowledgeAssistantsAPI
extends Object

Manage Knowledge Assistants and related resources.

Constructor Summary

Constructors

Constructor and Description
KnowledgeAssistantsAPI(ApiClient apiClient) Regular-use constructor
KnowledgeAssistantsAPI(KnowledgeAssistantsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Example	createExample(CreateExampleRequest request) Creates an example for a Knowledge Assistant.
KnowledgeAssistant	createKnowledgeAssistant(CreateKnowledgeAssistantRequest request) Creates a Knowledge Assistant.
KnowledgeSource	createKnowledgeSource(CreateKnowledgeSourceRequest request) Creates a Knowledge Source under a Knowledge Assistant.
void	deleteExample(DeleteExampleRequest request) Deletes an example from a Knowledge Assistant.
void	deleteExample(String name)
void	deleteKnowledgeAssistant(DeleteKnowledgeAssistantRequest request) Deletes a Knowledge Assistant.
void	deleteKnowledgeAssistant(String name)
void	deleteKnowledgeSource(DeleteKnowledgeSourceRequest request) Deletes a Knowledge Source.
void	deleteKnowledgeSource(String name)
Example	getExample(GetExampleRequest request) Gets an example from a Knowledge Assistant.
Example	getExample(String name)
KnowledgeAssistant	getKnowledgeAssistant(GetKnowledgeAssistantRequest request) Gets a Knowledge Assistant.
KnowledgeAssistant	getKnowledgeAssistant(String name)
KnowledgeSource	getKnowledgeSource(GetKnowledgeSourceRequest request) Gets a Knowledge Source.
KnowledgeSource	getKnowledgeSource(String name)
GetKnowledgeAssistantPermissionLevelsResponse	getPermissionLevels(GetKnowledgeAssistantPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetKnowledgeAssistantPermissionLevelsResponse	getPermissionLevels(String knowledgeAssistantId)
KnowledgeAssistantPermissions	getPermissions(GetKnowledgeAssistantPermissionsRequest request) Gets the permissions of a knowledge assistant.
KnowledgeAssistantPermissions	getPermissions(String knowledgeAssistantId)
KnowledgeAssistantsService	impl()
Iterable<Example>	listExamples(ListExamplesRequest request) Lists examples under a Knowledge Assistant.
Iterable<Example>	listExamples(String parent)
Iterable<KnowledgeAssistant>	listKnowledgeAssistants(ListKnowledgeAssistantsRequest request) List Knowledge Assistants
Iterable<KnowledgeSource>	listKnowledgeSources(ListKnowledgeSourcesRequest request) Lists Knowledge Sources under a Knowledge Assistant.
Iterable<KnowledgeSource>	listKnowledgeSources(String parent)
KnowledgeAssistantPermissions	setPermissions(KnowledgeAssistantPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
void	syncKnowledgeSources(SyncKnowledgeSourcesRequest request) Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources do not require sync)
Example	updateExample(UpdateExampleRequest request) Updates an example in a Knowledge Assistant.
KnowledgeAssistant	updateKnowledgeAssistant(UpdateKnowledgeAssistantRequest request) Updates a Knowledge Assistant.
KnowledgeSource	updateKnowledgeSource(UpdateKnowledgeSourceRequest request) Updates a Knowledge Source.
KnowledgeAssistantPermissions	updatePermissions(KnowledgeAssistantPermissionsRequest request) Updates the permissions on a knowledge assistant.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KnowledgeAssistantsAPI

public KnowledgeAssistantsAPI(ApiClient apiClient)

Regular-use constructor

KnowledgeAssistantsAPI

public KnowledgeAssistantsAPI(KnowledgeAssistantsService mock)

Constructor for mocks

Method Detail

createExample

public Example createExample(CreateExampleRequest request)

Creates an example for a Knowledge Assistant.

createKnowledgeAssistant

public KnowledgeAssistant createKnowledgeAssistant(CreateKnowledgeAssistantRequest request)

Creates a Knowledge Assistant.

createKnowledgeSource

public KnowledgeSource createKnowledgeSource(CreateKnowledgeSourceRequest request)

Creates a Knowledge Source under a Knowledge Assistant.

deleteExample

public void deleteExample(String name)

deleteExample

public void deleteExample(DeleteExampleRequest request)

Deletes an example from a Knowledge Assistant.

deleteKnowledgeAssistant

public void deleteKnowledgeAssistant(String name)

deleteKnowledgeAssistant

public void deleteKnowledgeAssistant(DeleteKnowledgeAssistantRequest request)

Deletes a Knowledge Assistant.

deleteKnowledgeSource

public void deleteKnowledgeSource(String name)

deleteKnowledgeSource

public void deleteKnowledgeSource(DeleteKnowledgeSourceRequest request)

Deletes a Knowledge Source.

getExample

public Example getExample(String name)

getExample

public Example getExample(GetExampleRequest request)

Gets an example from a Knowledge Assistant.

getKnowledgeAssistant

public KnowledgeAssistant getKnowledgeAssistant(String name)

getKnowledgeAssistant

public KnowledgeAssistant getKnowledgeAssistant(GetKnowledgeAssistantRequest request)

Gets a Knowledge Assistant.

getKnowledgeSource

public KnowledgeSource getKnowledgeSource(String name)

getKnowledgeSource

public KnowledgeSource getKnowledgeSource(GetKnowledgeSourceRequest request)

Gets a Knowledge Source.

getPermissionLevels

public GetKnowledgeAssistantPermissionLevelsResponse getPermissionLevels(String knowledgeAssistantId)

getPermissionLevels

public GetKnowledgeAssistantPermissionLevelsResponse getPermissionLevels(GetKnowledgeAssistantPermissionLevelsRequest request)

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

getPermissions

public KnowledgeAssistantPermissions getPermissions(String knowledgeAssistantId)

getPermissions

public KnowledgeAssistantPermissions getPermissions(GetKnowledgeAssistantPermissionsRequest request)

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

listExamples

public Iterable<Example> listExamples(String parent)

listExamples

public Iterable<Example> listExamples(ListExamplesRequest request)

Lists examples under a Knowledge Assistant.

listKnowledgeAssistants

public Iterable<KnowledgeAssistant> listKnowledgeAssistants(ListKnowledgeAssistantsRequest request)

List Knowledge Assistants

listKnowledgeSources

public Iterable<KnowledgeSource> listKnowledgeSources(String parent)

listKnowledgeSources

public Iterable<KnowledgeSource> listKnowledgeSources(ListKnowledgeSourcesRequest request)

Lists Knowledge Sources under a Knowledge Assistant.

setPermissions

public KnowledgeAssistantPermissions setPermissions(KnowledgeAssistantPermissionsRequest request)

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.

syncKnowledgeSources

public void syncKnowledgeSources(SyncKnowledgeSourcesRequest request)

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

updateExample

public Example updateExample(UpdateExampleRequest request)

Updates an example in a Knowledge Assistant.

updateKnowledgeAssistant

public KnowledgeAssistant updateKnowledgeAssistant(UpdateKnowledgeAssistantRequest request)

Updates a Knowledge Assistant.

updateKnowledgeSource

public KnowledgeSource updateKnowledgeSource(UpdateKnowledgeSourceRequest request)

Updates a Knowledge Source.

updatePermissions

public KnowledgeAssistantPermissions updatePermissions(KnowledgeAssistantPermissionsRequest request)

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

impl

public KnowledgeAssistantsService impl()