Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Description

Metadata

The standard JSON representation of the metadata as used in the MediaHaven REST API. : MediaHaven sidecar format

Config

The custom properties configured on the plugin → https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4438884395/Module+Plugins#Custom-properties

...

  • 200 OK with the response

  • 409 Conflict when the analysis is still pending

  • The output is a JSON array of JSON objects with the following properties

Property

Subproperty

Insights

Name

String

Type

Description

Insights

Array

Metadata

The

name of the insight

Insights

Id

String

The ID of the insight

Insights

Value

Array | String

The data as a string or an array of strings

standard JSON representation of the metadata as used in the MediaHaven REST API: MediaHaven sidecar format.

The generated insights, converted into metadata as instructed by the provided configuration.

RawData

String

The full raw data of the analysis; as a base64 encoded string.

Example

Expand
titleOutput
Code Block
languagejson
{
  "InsightsMetadata": [
    {
 
    "NameDynamic": "Summary",{
      "IdInsightsPoc": "SUMMARY", {
        "ValueSummary": "This is the summary of your document...",
    },    "EntitiesOrganisations": {
          "NameOrganisation": ["The European Parliament"EntitiesOrganisations, "Zeticon", ...]
      "Id  },
        "EntitiesLocations": "ENTITIES_ORG",{
          "ValueLocation": ["The European Parliament", "Zeticon", ...]
        },

  {       "NameEntitiesOrganisations": "EntitiesLocations",{
      "Id": "ENTITIES_LOC",       "ValueOrganisation": ["GentThe European Parliament", "AntwerpZeticon", ...]
        },

  {       "NameEntitiesLocations": "EntitiesPerson",{
      "Id": "ENTITIES_PERSON",       "ValueLocation": ["AliceGent", "BobAntwerp", ...]
        },
   {       "NameEntitiesGeneralItems": "EntitiesGeneral",{
      "Id": "ENTITIES_MISC",       "ValueItem": ["Document", "Paper", ...]
        },

   {     "NameActions": "Actions",{
    "Id": "ACTIONS",     "ValueAction": ["voorstellen", "afwerken", ...]
        }
     ] }
    }
  },
  "RawData": <RAW DATA>
}