Skip to main content

@wildix/wim-knowledge-base-client

wim-knowledge-base-client package

Classes

Class

Description

CleanDataSourceCommand

Clean the data source by its ID. It will clean all documents and sync logs. This operation is irreversible.

CloneDataSourceCommand

Clone a data source by its ID. Only configuration will be cloned, not the data.

ConfigureDataSourceCommand

Configure a data source by its ID

CreateDataSourceCommand

Register a new data source with minimal configuration. All other parameters will be set in update operation.

CreateDocumentCommand

Create a new document for a data source by its ID

CreateKnowledgeBaseCommand

Create a new knowledge base

DataSourceNotFoundException

DeleteDataSourceCommand

Delete a data source by its ID

DeleteDocumentCommand

Delete a document by its ID

DeleteKnowledgeBaseCommand

Delete a knowledge base by its ID

DescribeDataSourceCommand

Describe the data source by its ID. It will return additional information about the data source based on the parameters provided.

DocumentNotFoundException

ForbiddenException

GenerateSearchAnswerCommand

Query a knowledge base by its ID and return the answer from the LLM

GetDataSourceCommand

Get a data source by its ID

GetDataSourceSyncStatusCommand

Get the sync status of a data source by its ID

GetDocumentChunksCommand

Get the chunks of a document by its ID

GetDocumentCommand

Get a document by its ID

GetDocumentDownloadUrlCommand

Get a presigned URL for downloading the original file of the document

GetDocumentMarkdownCommand

Get the markdown content of a document by its ID

GetDocumentUploadUrlCommand

Get a presigned URL for uploading the original file of the document. You must upload the file to this URL using the PUT method.

GetDocumentWithContentAndChunksCommand

Get a document by its ID with its content and chunks

GetKnowledgeBaseCommand

Get a knowledge base by its ID

KnowledgeBase

KnowledgeBaseClient

KnowledgeBaseNotFoundException

KnowledgeBaseServiceException

Base exception class for all service exceptions from KnowledgeBase service.

ListDataSourcesCommand

List all data sources for the current company

ListDataSourceStatisticsCommand

List the statistics of a data source by its ID

ListDataSourceSynchronizationLogsCommand

Get the sync logs of a data source by its ID

ListDocumentsCommand

List all documents for a data source by its ID

ListHistoryStatisticsCommand

You can use this endpoint to retrieve the search history statistics.

ListKnowledgeBasesCommand

List all knowledge bases for the current company

ListSearchQueriesHistoryCommand

You can use this endpoint to retrieve the search history.

SearchKnowledgeBaseCommand

Search a knowledge base by its ID and return the chunks that match the query with its score

StartSyncDataSourceCommand

Start the sync of a data source by its ID

StopSyncDataSourceCommand

Stop the sync of a data source by its ID

UnauthorizedException

UpdateDataSourceCommand

Update a data source by its ID

UpdateDocumentCommand

Update a document by its ID

UpdateKnowledgeBaseCommand

Update a knowledge base by its ID

ValidationException

Interfaces

Interface

Description

AnswerMetadata

ChunkItem

CleanDataSourceCommandInput

The input for CleanDataSourceCommand.

CleanDataSourceCommandOutput

The output of CleanDataSourceCommand.

CleanDataSourceInput

CleanDataSourceOutput

ClientDefaults

CloneDataSourceCommandInput

The input for CloneDataSourceCommand.

CloneDataSourceCommandOutput

The output of CloneDataSourceCommand.

CloneDataSourceInput

CloneDataSourceOutput

ConfigureDataSourceCommandInput

The input for ConfigureDataSourceCommand.

ConfigureDataSourceCommandOutput

The output of ConfigureDataSourceCommand.

ConfigureDataSourceInput

ConfigureDataSourceOutput

ConfluenceConfig

ConfluencePagesConfig

CreateDataSourceCommandInput

The input for CreateDataSourceCommand.

CreateDataSourceCommandOutput

The output of CreateDataSourceCommand.

CreateDataSourceInput

CreateDataSourceOutput

CreateDocumentCommandInput

The input for CreateDocumentCommand.

CreateDocumentCommandOutput

The output of CreateDocumentCommand.

CreateDocumentInput

CreateDocumentOutput

CreateKnowledgeBaseCommandInput

The input for CreateKnowledgeBaseCommand.

CreateKnowledgeBaseCommandOutput

The output of CreateKnowledgeBaseCommand.

CreateKnowledgeBaseInput

CreateKnowledgeBaseOutput

DailyGlobalStatistics

DailySearchStatistics

DataSourceItem

DataSourceStatistics

DeleteDataSourceCommandInput

The input for DeleteDataSourceCommand.

DeleteDataSourceCommandOutput

The output of DeleteDataSourceCommand.

DeleteDataSourceInput

DeleteDataSourceOutput

DeleteDocumentCommandInput

The input for DeleteDocumentCommand.

DeleteDocumentCommandOutput

The output of DeleteDocumentCommand.

DeleteDocumentInput

DeleteDocumentOutput

DeleteKnowledgeBaseCommandInput

The input for DeleteKnowledgeBaseCommand.

DeleteKnowledgeBaseCommandOutput

The output of DeleteKnowledgeBaseCommand.

DeleteKnowledgeBaseInput

DeleteKnowledgeBaseOutput

DescribeDataSourceCommandInput

The input for DescribeDataSourceCommand.

DescribeDataSourceCommandOutput

The output of DescribeDataSourceCommand.

DescribeDataSourceConfluencePageResult

DescribeDataSourceConfluencePagesParameters

DescribeDataSourceConfluenceParameters

DescribeDataSourceConfluenceResult

DescribeDataSourceConfluenceSpaceResult

DescribeDataSourceConfluenceSpacesParameters

DescribeDataSourceGDriveFolderResult

DescribeDataSourceGDriveFoldersParameters

DescribeDataSourceGDriveParameters

DescribeDataSourceGDriveResult

DescribeDataSourceGDriveSessionParameters

DescribeDataSourceInput

DescribeDataSourceOutput

DescribeDataSourceParameters

DescribeDataSourceResult

DocumentItem

DocumentsStatistics

GDriveConfig

GDriveFoldersConfig

GenerateSearchAnswerCommandInput

The input for GenerateSearchAnswerCommand.

GenerateSearchAnswerCommandOutput

The output of GenerateSearchAnswerCommand.

GenerateSearchAnswerInput

GenerateSearchAnswerOutput

GetDataSourceCommandInput

The input for GetDataSourceCommand.

GetDataSourceCommandOutput

The output of GetDataSourceCommand.

GetDataSourceInput

GetDataSourceOutput

GetDataSourceSyncStatusCommandInput

The input for GetDataSourceSyncStatusCommand.

GetDataSourceSyncStatusCommandOutput

The output of GetDataSourceSyncStatusCommand.

GetDataSourceSyncStatusInput

GetDataSourceSyncStatusOutput

GetDocumentChunksCommandInput

The input for GetDocumentChunksCommand.

GetDocumentChunksCommandOutput

The output of GetDocumentChunksCommand.

GetDocumentChunksInput

GetDocumentChunksOutput

GetDocumentCommandInput

The input for GetDocumentCommand.

GetDocumentCommandOutput

The output of GetDocumentCommand.

GetDocumentDownloadUrlCommandInput

The input for GetDocumentDownloadUrlCommand.

GetDocumentDownloadUrlCommandOutput

The output of GetDocumentDownloadUrlCommand.

GetDocumentDownloadUrlInput

GetDocumentDownloadUrlOutput

GetDocumentInput

GetDocumentMarkdownCommandInput

The input for GetDocumentMarkdownCommand.

GetDocumentMarkdownCommandOutput

The output of GetDocumentMarkdownCommand.

GetDocumentMarkdownInput

GetDocumentMarkdownOutput

GetDocumentOutput

GetDocumentUploadUrlCommandInput

The input for GetDocumentUploadUrlCommand.

GetDocumentUploadUrlCommandOutput

The output of GetDocumentUploadUrlCommand.

GetDocumentUploadUrlInput

GetDocumentUploadUrlOutput

GetDocumentWithContentAndChunksCommandInput

The input for GetDocumentWithContentAndChunksCommand.

GetDocumentWithContentAndChunksCommandOutput

The output of GetDocumentWithContentAndChunksCommand.

GetDocumentWithContentAndChunksInput

GetDocumentWithContentAndChunksOutput

GetKnowledgeBaseCommandInput

The input for GetKnowledgeBaseCommand.

GetKnowledgeBaseCommandOutput

The output of GetKnowledgeBaseCommand.

GetKnowledgeBaseInput

GetKnowledgeBaseOutput

HistoryStatistics

HistoryStatisticsFilter

KnowledgeBase

KnowledgeBaseClientConfig

The configuration interface of KnowledgeBaseClient class constructor that set the region, credentials and other options.

KnowledgeBaseClientResolvedConfig

The resolved configuration interface of KnowledgeBaseClient class. This is resolved and normalized from the constructor configuration interface.

KnowledgeBaseItem

KnowledgeBaseStatistics

ListDataSourcesCommandInput

The input for ListDataSourcesCommand.

ListDataSourcesCommandOutput

The output of ListDataSourcesCommand.

ListDataSourcesInput

ListDataSourcesOutput

ListDataSourceStatisticsCommandInput

The input for ListDataSourceStatisticsCommand.

ListDataSourceStatisticsCommandOutput

The output of ListDataSourceStatisticsCommand.

ListDataSourceStatisticsInput

ListDataSourceStatisticsOutput

ListDataSourceSynchronizationLogsCommandInput

The input for ListDataSourceSynchronizationLogsCommand.

ListDataSourceSynchronizationLogsCommandOutput

The output of ListDataSourceSynchronizationLogsCommand.

ListDataSourceSynchronizationLogsInput

ListDataSourceSynchronizationLogsOutput

ListDocumentsCommandInput

The input for ListDocumentsCommand.

ListDocumentsCommandOutput

The output of ListDocumentsCommand.

ListDocumentsInput

ListDocumentsOutput

ListHistoryStatisticsCommandInput

The input for ListHistoryStatisticsCommand.

ListHistoryStatisticsCommandOutput

The output of ListHistoryStatisticsCommand.

ListHistoryStatisticsInput

ListHistoryStatisticsOutput

ListKnowledgeBasesCommandInput

The input for ListKnowledgeBasesCommand.

ListKnowledgeBasesCommandOutput

The output of ListKnowledgeBasesCommand.

ListKnowledgeBasesInput

ListKnowledgeBasesOutput

ListSearchQueriesHistoryCommandInput

The input for ListSearchQueriesHistoryCommand.

ListSearchQueriesHistoryCommandOutput

The output of ListSearchQueriesHistoryCommand.

ListSearchQueriesHistoryInput

ListSearchQueriesHistoryOutput

PaginationMetadata

RuntimeExtension

SearchEnrichDataStage

SearchHistoryEmbeddingStage

SearchHistoryFilter

SearchHistoryItem

SearchHistoryOverallStage

SearchHistoryRequest

SearchHistoryResultItem

SearchHistorySearchStage

SearchHistoryStages

SearchHistoryTransformQueryStage

SearchKnowledgeBaseCommandInput

The input for SearchKnowledgeBaseCommand.

SearchKnowledgeBaseCommandOutput

The output of SearchKnowledgeBaseCommand.

SearchKnowledgeBaseInput

SearchKnowledgeBaseOutput

SearchKnowledgeBaseResultItem

SearchResultMetadata

StartSyncDataSourceCommandInput

The input for StartSyncDataSourceCommand.

StartSyncDataSourceCommandOutput

The output of StartSyncDataSourceCommand.

StartSyncDataSourceInput

StartSyncDataSourceOutput

StopSyncDataSourceCommandInput

The input for StopSyncDataSourceCommand.

StopSyncDataSourceCommandOutput

The output of StopSyncDataSourceCommand.

StopSyncDataSourceInput

StopSyncDataSourceOutput

SyncLogItem

UpdateDataSourceCommandInput

The input for UpdateDataSourceCommand.

UpdateDataSourceCommandOutput

The output of UpdateDataSourceCommand.

UpdateDataSourceInput

UpdateDataSourceOutput

UpdateDocumentCommandInput

The input for UpdateDocumentCommand.

UpdateDocumentCommandOutput

The output of UpdateDocumentCommand.

UpdateDocumentInput

UpdateDocumentOutput

UpdateKnowledgeBaseCommandInput

The input for UpdateKnowledgeBaseCommand.

UpdateKnowledgeBaseCommandOutput

The output of UpdateKnowledgeBaseCommand.

UpdateKnowledgeBaseInput

UpdateKnowledgeBaseOutput

Namespaces

Namespace

Description

DataSourceConfig

Variables

Variable

Description

ConfluenceSpaceType

DataSourceType

DocumentStatus

ScheduleConfiguration

SearchStrategy

SearchThresholdValue

SyncDataSourceMode

SyncDataSourceStatus

SyncLogLevel

Type Aliases

Type Alias

Description

ConfluenceSpaceType

DataSourceConfig

DataSourceType

DocumentStatus

KnowledgeBaseClientConfigType

KnowledgeBaseClientResolvedConfigType

ScheduleConfiguration

SearchStrategy

SearchThresholdValue

ServiceInputTypes

ServiceOutputTypes

SyncDataSourceMode

SyncDataSourceStatus

SyncLogLevel