KnowledgeBasesOperations interface

Package:

@azure/ai-discovery

Interface representing a KnowledgeBases operations.

Properties

cancelIndexing	Cancel indexing.
createOrUpdate	Creates or updates a KnowledgeBase.
deleteKnowledgeBase	Delete a KnowledgeBase.
get	Fetch a KnowledgeBase by name.
getOperationStatus	Get the status of a long-running operation.
list	List KnowledgeBase resources
search	Search the knowledge base.
startIndexing	Start indexing.

Property Details

cancelIndexing

Cancel indexing.

cancelIndexing: (knowledgeBaseName: string, options?: KnowledgeBasesCancelIndexingOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(knowledgeBaseName: string, options?: KnowledgeBasesCancelIndexingOptionalParams) => PollerLike<OperationState<void>, void>

createOrUpdate

Creates or updates a KnowledgeBase.

createOrUpdate: (knowledgeBaseName: string, resource: KnowledgeBaseCreateOrUpdateContent, options?: KnowledgeBasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<KnowledgeBase>, KnowledgeBase>

Property Value

(knowledgeBaseName: string, resource: KnowledgeBaseCreateOrUpdateContent, options?: KnowledgeBasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<KnowledgeBase>, KnowledgeBase>

deleteKnowledgeBase

Delete a KnowledgeBase.

deleteKnowledgeBase: (knowledgeBaseName: string, options?: KnowledgeBasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(knowledgeBaseName: string, options?: KnowledgeBasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Fetch a KnowledgeBase by name.

get: (knowledgeBaseName: string, options?: KnowledgeBasesGetOptionalParams) => Promise<KnowledgeBase>

Property Value

(knowledgeBaseName: string, options?: KnowledgeBasesGetOptionalParams) => Promise<KnowledgeBase>

getOperationStatus

Get the status of a long-running operation.

getOperationStatus: (knowledgeBaseName: string, operationId: string, options?: KnowledgeBasesGetOperationStatusOptionalParams) => Promise<KnowledgeBaseOperationResponseUnion>

Property Value

(knowledgeBaseName: string, operationId: string, options?: KnowledgeBasesGetOperationStatusOptionalParams) => Promise<KnowledgeBaseOperationResponseUnion>

list

List KnowledgeBase resources

list: (options?: KnowledgeBasesListOptionalParams) => PagedAsyncIterableIterator<KnowledgeBase, KnowledgeBase[], PageSettings>

Property Value

(options?: KnowledgeBasesListOptionalParams) => PagedAsyncIterableIterator<KnowledgeBase, KnowledgeBase[], PageSettings>

search

Search the knowledge base.

search: (knowledgeBaseName: string, body: SearchRequest, options?: KnowledgeBasesSearchOptionalParams) => PollerLike<OperationState<KnowledgeBaseSearchOperationResponse>, KnowledgeBaseSearchOperationResponse>

Property Value

(knowledgeBaseName: string, body: SearchRequest, options?: KnowledgeBasesSearchOptionalParams) => PollerLike<OperationState<KnowledgeBaseSearchOperationResponse>, KnowledgeBaseSearchOperationResponse>

startIndexing

Start indexing.

startIndexing: (knowledgeBaseName: string, options?: KnowledgeBasesStartIndexingOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(knowledgeBaseName: string, options?: KnowledgeBasesStartIndexingOptionalParams) => PollerLike<OperationState<void>, void>