Type Alias KnowledgebasesAPI

type KnowledgebasesAPI = {
    cancelKnowledgebaseDatasource: typeof cancelKnowledgebaseDatasource;
    clearCache: typeof clearCache;
    createKnowledgebase: typeof createKnowledgebase;
    createKnowledgebaseDatasource: typeof createKnowledgebaseDatasource;
    createKnowledgebaseDatasourceSchedule: typeof createKnowledgebaseDatasourceSchedule;
    deleteKnowledgebase: typeof deleteKnowledgebase;
    deleteKnowledgebaseDatasource: typeof deleteKnowledgebaseDatasource;
    deleteKnowledgebaseDatasourceSchedule: typeof deleteKnowledgebaseDatasourceSchedule;
    downloadKnowledgebaseDatasource: typeof downloadKnowledgebaseDatasource;
    getKnowledgebase: typeof getKnowledgebase;
    getKnowledgebaseDatasourceHistories: typeof getKnowledgebaseDatasourceHistories;
    getKnowledgebaseDatasourceHistory: typeof getKnowledgebaseDatasourceHistory;
    getKnowledgebaseDatasourceSchedule: typeof getKnowledgebaseDatasourceSchedule;
    getKnowledgebaseHistories: typeof getKnowledgebaseHistories;
    getKnowledgebases: typeof getKnowledgebases;
    patchKnowledgebase: typeof patchKnowledgebase;
    syncKnowledgebaseDatasource: typeof syncKnowledgebaseDatasource;
    updateKnowledgebaseDatasource: typeof updateKnowledgebaseDatasource;
}
Index

Properties

cancelKnowledgebaseDatasource clearCache createKnowledgebase createKnowledgebaseDatasource createKnowledgebaseDatasourceSchedule deleteKnowledgebase deleteKnowledgebaseDatasource deleteKnowledgebaseDatasourceSchedule downloadKnowledgebaseDatasource getKnowledgebase getKnowledgebaseDatasourceHistories getKnowledgebaseDatasourceHistory getKnowledgebaseDatasourceSchedule getKnowledgebaseHistories getKnowledgebases patchKnowledgebase syncKnowledgebaseDatasource updateKnowledgebaseDatasource

Properties

cancelKnowledgebaseDatasource: typeof cancelKnowledgebaseDatasource

Cancels ongoing sync for a specified datasource.

The id of the knowledgebase the datasource belongs to.

The id of the datasource to cancel sync for.

CancelKnowledgebaseDatasourceHttpError

clearCache: typeof clearCache

Clears the cache for knowledgebases api requests.

createKnowledgebase: typeof createKnowledgebase

Creates a new knowledgebase.

Param: body

an object with the body content

CreateKnowledgebaseHttpError

createKnowledgebaseDatasource: typeof createKnowledgebaseDatasource

Adds a datasource to a knowledgebase.

The id of the knowledgebase.

Param: body

an object with the body content

CreateKnowledgebaseDatasourceHttpError

createKnowledgebaseDatasourceSchedule: typeof createKnowledgebaseDatasourceSchedule

Creates or updates a specified datasource schedule.

The id of the knowledgebase the schedule belongs to.

The id of the datasource the schedule belongs to.

Param: body

an object with the body content

CreateKnowledgebaseDatasourceScheduleHttpError

deleteKnowledgebase: typeof deleteKnowledgebase

Deletes a knowledgebase and all of its resources.

The id of the knowledgebase to delete.

DeleteKnowledgebaseHttpError

deleteKnowledgebaseDatasource: typeof deleteKnowledgebaseDatasource

Deletes a specified datasource and all its resources.

The id of the knowledgebase the datasource belongs to.

The id of the datasource to delete.

DeleteKnowledgebaseDatasourceHttpError

deleteKnowledgebaseDatasourceSchedule: typeof deleteKnowledgebaseDatasourceSchedule

Delete knowledgebase datasource schedule

The id of the knowledgebase the schedule belongs to.

The id of the datasource the schedule belongs to.

DeleteKnowledgebaseDatasourceScheduleHttpError

downloadKnowledgebaseDatasource: typeof downloadKnowledgebaseDatasource

Download knowledgebase datasource reference

The id of the knowledgebase the datasource belongs to.

The id of the datasource to download from.

Param: body

an object with the body content

DownloadKnowledgebaseDatasourceHttpError

getKnowledgebase: typeof getKnowledgebase

Retrieves a specific knowledgebase.

The id of the knowledgebase to retrieve.

GetKnowledgebaseHttpError

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.

The id of the knowledgebase the datasource belongs to.

The id of the datasource.

an object with query parameters

GetKnowledgebaseDatasourceHistoriesHttpError

getKnowledgebaseDatasourceHistory: typeof getKnowledgebaseDatasourceHistory

Retrieves detailed sync history for a specified datasource.

The id of the knowledgebase the datasource belongs to.

The id of the datasource.

The sync identifier.

GetKnowledgebaseDatasourceHistoryHttpError

getKnowledgebaseDatasourceSchedule: typeof getKnowledgebaseDatasourceSchedule

Get a knowledgebase datasource schedule

The id of the knowledgebase the schedule belongs to.

The id of the datasource the schedule belongs to.

GetKnowledgebaseDatasourceScheduleHttpError

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.

The id of the knowledgebase.

an object with query parameters

GetKnowledgebaseHistoriesHttpError

getKnowledgebases: typeof getKnowledgebases

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

an object with query parameters

GetKnowledgebasesHttpError

patchKnowledgebase: typeof patchKnowledgebase

Updates properties of a specific knowledgebase.

The knowledgebase id.

Param: body

an object with the body content

PatchKnowledgebaseHttpError

syncKnowledgebaseDatasource: typeof syncKnowledgebaseDatasource

Starts syncing a specified datasource to a specified knowledgebase index.

The id of the knowledgebase the datasource belongs to.

The id of the datasource to sync.

an object with query parameters

SyncKnowledgebaseDatasourceHttpError

updateKnowledgebaseDatasource: typeof updateKnowledgebaseDatasource

Update a knowledgebase datasource

The id of a knowledgebase.

The id of the datasource to update.

Param: body

an object with the body content

UpdateKnowledgebaseDatasourceHttpError

Settings

Member Visibility

On This Page

Properties