Introduction
Each of the Modules consist of one or more plugins.
Categories
Category | Meaning | Example | Custom properties | Since |
|---|---|---|---|---|
Feature | The plugin is a feature toggle, whose activation for one more organisations, triggers its effects. | The OCR plugin |
| |
Embedding | Plugins of this category specify credentials to an external API implementing the AI Connector API contract that then generate embeddings based on the provided text or metadata. | The perceptual hash plugin |
| |
Generative | Plugins of this category specify credentials to an external API implementing the AI Connector API contract that then generate metadata as specified in the custom properties. | The Open AI plugin | The list of metadat fields to generate "Fields": {
"Descriptive.Description": "Give a description for the image",
"Descriptive.Title": "Give a prosaic title"
},
|
|
ActionModel | Plugins of this category specify whether a particular action definition is active for an organisation | The transfer flow plugin |
| |
Business Intelligence | Plugins (connectors) that return reports back to engine | Metabase plugin Tableau Plugin Power BI Plugin | 25.1 |
Properties
Property | Description | Default | Required | Example |
|---|---|---|---|---|
Plugin ID | Unique ID of the plugin; primary key |
|
| |
Name | Unique name of the plugin |
|
| |
Category | One of the https://mediahaven.atlassian.net/wiki/spaces/CS/pages/edit-v2/4438884395#Categories as described above |
|
|
|
Uri | URI of the REST API implementing the AI Connector API contract |
|
| |
Secret | Secret that will be validated by the external plugin or passed further downstream. |
| ||
DottedKey | Used for plugins of category |
|
|
|
Custom properties | Provides additional properties to the plugin. |
|
|
|
