Symbiosika Sync Knowledge Item icon

Symbiosika Sync Knowledge Item

Sync a knowledge item with a Symbiosika Assistant

Overview

The Symbiosika Sync Knowledge Item node enables synchronization of knowledge items with a Symbiosika Assistant. It supports three main operations:

  • Sync Knowledge File: Uploads and syncs a binary knowledge file to the assistant.
  • Sync Knowledge Entry By Text Only: Syncs a knowledge entry using plain text and metadata without any file upload.
  • Check Knowledge Item If It Should Be Synced: Checks if a knowledge item exists on the server and whether it requires syncing based on its last change date.

This node is useful in scenarios where you want to keep an AI assistant's knowledge base up-to-date by programmatically syncing documents or textual knowledge entries. For example, you might use it to automatically update training materials, FAQs, or other reference documents stored in your system so that the assistant always has the latest information.

Properties

Name Meaning
Organisation Name or ID Select or specify the organisation under which the knowledge item will be synced. This identifies the scope for the knowledge data.
Operation Choose the action to perform:
- Sync Knowledge File
- Sync Knowledge Entry By Text Only
- Check Knowledge Item If It Should Be Synced
Sync-ID (External) A unique external identifier for the knowledge item to sync or check. Used to track and identify the item on the server.
Last Change of the Item The timestamp or date string representing the last modification time of the knowledge item. Helps determine if syncing is necessary.
Binary Property (Only for Sync Knowledge File) The name of the binary property in the input data that contains the file to upload and sync.
Knowledge Text (Only for Sync Knowledge Entry By Text Only) The textual content of the knowledge entry to sync.
Knowledge Title (Only for Sync Knowledge Entry By Text Only) The title or heading of the knowledge entry.
Knowledge Group Name or ID Optionally select or specify a knowledge group within the organisation to categorize the knowledge item.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON object contains the response from the Symbiosika API for the respective operation:

  • For Sync Knowledge File and Sync Knowledge Entry By Text Only, the output includes confirmation details about the uploaded/synced knowledge item.
  • For Check Knowledge Item If It Should Be Synced, the output contains information indicating whether the item exists and if syncing is required.
  • In case of errors (if "Continue On Fail" is enabled), the output JSON will contain an error field with the error message.

If the node uploads files, it expects binary data as input but does not output binary data itself.

Dependencies

  • Requires an API key credential for authenticating with the Symbiosika Chat API.
  • The node makes HTTP requests to the Symbiosika API endpoints:
    • To fetch organisations and knowledge groups dynamically.
    • To check knowledge items and upload knowledge files or text entries.
  • The API URL and key must be configured in the credentials used by the node.

Troubleshooting

  • No binary data found in property: When using the Sync Knowledge File operation, ensure the specified binary property exists and contains valid file data in the input.
  • Invalid response format: If the node fails to load organisations or knowledge groups, verify that the API key is correct and the API endpoint is reachable.
  • Operation not supported: Selecting an unsupported operation value will throw an error; ensure the operation parameter is set correctly.
  • Network or authentication errors: Check API key validity and network connectivity to the Symbiosika API.
  • Enable "Continue On Fail" to allow processing multiple items even if some fail.

Links and References

Discussion