Type Alias KnowledgebasesAPI

Index

Properties

Properties

cancelKnowledgebaseDatasource

cancelKnowledgebaseDatasource: typeof cancelKnowledgebaseDatasource

Cancels ongoing sync for a specified datasource.

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource to cancel sync for.

Throws

CancelKnowledgebaseDatasourceHttpError

clearCache

clearCache: typeof clearCache

Clears the cache for knowledgebases api requests.

createKnowledgebase

createKnowledgebase: typeof createKnowledgebase

Creates a new knowledgebase.

Param: body

an object with the body content

Throws

CreateKnowledgebaseHttpError

createKnowledgebaseDatasource

createKnowledgebaseDatasource: typeof createKnowledgebaseDatasource

Adds a datasource to a knowledgebase.

Param: id

The id of the knowledgebase.

Param: body

an object with the body content

Throws

CreateKnowledgebaseDatasourceHttpError

createKnowledgebaseDatasourceSchedule

createKnowledgebaseDatasourceSchedule: typeof createKnowledgebaseDatasourceSchedule

Creates or updates a specified datasource schedule.

Param: id

The id of the knowledgebase the schedule belongs to.

Param: datasourceId

The id of the datasource the schedule belongs to.

Param: body

an object with the body content

Throws

CreateKnowledgebaseDatasourceScheduleHttpError

deleteKnowledgebase

deleteKnowledgebase: typeof deleteKnowledgebase

Deletes a knowledgebase and all of its resources.

Param: id

The id of the knowledgebase to delete.

Throws

DeleteKnowledgebaseHttpError

deleteKnowledgebaseDatasource

deleteKnowledgebaseDatasource: typeof deleteKnowledgebaseDatasource

Deletes a specified datasource and all its resources.

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource to delete.

Throws

DeleteKnowledgebaseDatasourceHttpError

deleteKnowledgebaseDatasourceSchedule

deleteKnowledgebaseDatasourceSchedule: typeof deleteKnowledgebaseDatasourceSchedule

Delete knowledgebase datasource schedule

Param: id

The id of the knowledgebase the schedule belongs to.

Param: datasourceId

The id of the datasource the schedule belongs to.

Throws

DeleteKnowledgebaseDatasourceScheduleHttpError

downloadKnowledgebaseDatasource

downloadKnowledgebaseDatasource: typeof downloadKnowledgebaseDatasource

Download knowledgebase datasource reference

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource to download from.

Param: body

an object with the body content

Throws

DownloadKnowledgebaseDatasourceHttpError

getKnowledgebase

getKnowledgebase: typeof getKnowledgebase

Retrieves a specific knowledgebase.

Param: id

The id of the knowledgebase to retrieve.

Throws

GetKnowledgebaseHttpError

getKnowledgebaseDatasourceHistories

getKnowledgebaseDatasourceHistories: typeof getKnowledgebaseDatasourceHistories

Retrieves sync history for a specified datasource in a knowledgebase. Returns a 404 if there is no sync history, or if the calling user doesn't have access to the datasource.

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource.

Param: query

an object with query parameters

Throws

GetKnowledgebaseDatasourceHistoriesHttpError

getKnowledgebaseDatasourceHistory

getKnowledgebaseDatasourceHistory: typeof getKnowledgebaseDatasourceHistory

Deprecated

Retrieves detailed sync history for a specified datasource.

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource.

Param: syncId

The sync identifier.

Throws

GetKnowledgebaseDatasourceHistoryHttpError

getKnowledgebaseDatasourceSchedule

getKnowledgebaseDatasourceSchedule: typeof getKnowledgebaseDatasourceSchedule

Get a knowledgebase datasource schedule

Param: id

The id of the knowledgebase the schedule belongs to.

Param: datasourceId

The id of the datasource the schedule belongs to.

Throws

GetKnowledgebaseDatasourceScheduleHttpError

getKnowledgebaseHistories

getKnowledgebaseHistories: typeof getKnowledgebaseHistories

Retrieves sync history for the specified knowledgebase. Will return a 404 if no sync history exists, or if the calling user does not have access to synced datasources.

Param: id

The id of the knowledgebase.

Param: query

an object with query parameters

Throws

GetKnowledgebaseHistoriesHttpError

getKnowledgebases

getKnowledgebases: typeof getKnowledgebases

Returns a list of all knowledgebases the user has access to.

Param: query

an object with query parameters

Throws

GetKnowledgebasesHttpError

patchKnowledgebase

patchKnowledgebase: typeof patchKnowledgebase

Updates properties of a specific knowledgebase.

Param: id

The knowledgebase id.

Param: body

an object with the body content

Throws

PatchKnowledgebaseHttpError

searchKnowledgebase

searchKnowledgebase: typeof searchKnowledgebase

Execute search with either SIMPLE or FULL mode. SIMPLE does semantic search while FULL will also do reranking and include keyword based chunks. Use topN to control number of chunks in response, max limit is 50. Default to 5.

Param: id

The ID of the knowledgebase

Param: body

an object with the body content

Throws

SearchKnowledgebaseHttpError

syncKnowledgebaseDatasource

syncKnowledgebaseDatasource: typeof syncKnowledgebaseDatasource

Starts syncing a specified datasource to a specified knowledgebase index.

Param: id

The id of the knowledgebase the datasource belongs to.

Param: datasourceId

The id of the datasource to sync.

Param: query

an object with query parameters

Throws

SyncKnowledgebaseDatasourceHttpError

updateKnowledgebaseDatasource

updateKnowledgebaseDatasource: typeof updateKnowledgebaseDatasource

Update a knowledgebase datasource

Param: id

The id of a knowledgebase.

Param: datasourceId

The id of the datasource to update.

Param: body

an object with the body content

Throws

UpdateKnowledgebaseDatasourceHttpError