Module Plugins
Introduction
Module plugins are packaged into Modules and form the salient part offering:
Toggleable features
Connectors allowing for extending MediaHaven with the power of external services such as AI.
Categories
Category | Meaning | Example | Connector Contract | Since |
---|---|---|---|---|
Feature | The plugin is a feature toggle, whose activation for one or more organisations, triggers its effects. | The OCR plugin |
|
|
Embedding | Plugins in this category specify credentials to an external API, which generates embeddings based on the provided text or metadata. | The perceptual hash plugin |
| |
Generative | Plugins in this category specify credentials to an external API, which generates metadata as specified in the custom properties. | The Open AI plugin |
| |
ActionModel | Plugins of this category specify whether a particular action definition is active for an organisation. See also https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4546527239/Action+model#Custom-actions | The transfer flow plugin |
|
|
Business Intelligence | Plugins of this category specify credentials to an external API that returns the report’s URI so InformationHaven can embed it. | InformationHaven our own (reference) implementation
Possible future implementation by external integrator/client
|
| |
Insights | Analyse the objects during ingest and provide structured metadata as a result |
|
| |
Validation | Validate the objects based on their metadata and original representation |
|
|
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 Module Plugins | 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. |
|
|
|