Knowledge Connector API

The Knowledge Connector API is a toolset for developers to create custom Knowledge Connectors and integrate external knowledge databases into Cognigy.AI. The toolset is intended be used within the Knowledge Connector implementation. This API provides functions to create and delete Knowledge Sources and the relative Knowledge Chunks.

Use Cases

• Create and Update Knowledge Sources — detect documents that have been created or changed and import them from cloud-based document repositories, for example, SharePoint, Confluence.
• API Integration — automate knowledge imports from REST APIs.

Knowledge Connector API Functions

upsertKnowledgeSource

Syntax: api.upsertKnowledgeSource(params)

Creates or updates a Knowledge Source with the specified name, description, Source Tags, and number of Knowledge Chunks. Supports knowledge synchronization.

createKnowledgeSource (deprecated)

Syntax: api.createKnowledgeSource(params)

Creates a new Knowledge Source with the specified name, description, Source Tags, and number of Knowledge Chunks.

deleteKnowledgeSource

Syntax: api.deleteKnowledgeSource(params)

Deletes a Knowledge Source.

createKnowledgeChunk

Syntax: api.createKnowledgeChunk(params)

Creates a Knowledge Chunk in a Knowledge Source, containing text content and optional Chunk metadata.