Versions Compared

Old Version 7

changes.mady.by.user Alexis Rombaut

Saved on

compared with

New Version Current

changes.mady.by.user Alexis Rombaut

Saved on

Key

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

...

Expand
titleExample custom properties
Code Block
  {
    "FieldsConfig": {
      "SUMMARY": "Dynamic.PocInsights.Summary",
      "ENTITIES_PERSONS": "Dynamic.PocInsights.Persons.Person",
      "ENTITIES_ORGANISATIONS": "Dynamic.PocInsights.Organisations.Organisation",
      "ENTITIES_LOCATIONS": "Dynamic.PocInsights.InsightsPocLocations.SummaryLocation",
      "EntitiesENTITIES_GENERAL": "Dynamic.InsightsPocPocInsights.GeneralItems.EntitiesItem",
      "ActionsACTIONS": "Dynamic.InsighstPocPocInsights.Actions.Action",
      "OcrOCR": "Dynamic.InsightsPoc.OcrPocOcr",
    }
  }

Data Objects

When ingesting Data Objects, the analysis step will be called in the context of the original representation, whereas the get insights step will be called in the context of the data object itself.

API

Common

For all methods the following HTTP header is provided:

...

The input is a JSON body with the following properties

Property

Type

Description

Metadata

Object

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

Config

Object

The custom properties configured on the plugin

→

, as described above: https://mediahaven.atlassian.net/wiki/spaces/CS/pages/

4438884395

4652335133/

Module+Plugins#Custom-properties

Insights+Connector+Contract#Configuration

Response / Output

  • The HTTP response 202 Accepted 204 No Content when the analysis was successfully started

...

Expand
titleInput
Code Block
languagejson
{
  "Config": {
    "SUMMARY": "Dynamic.PocInsights.Summary",
    "ENTITIES_PERSONS": "Dynamic.PocInsights.Persons.Person",
    "ENTITIES_ORGANISATIONS": "Dynamic.PocInsights.Organisations.Organisation",
    "CustomPropertyA" : "example" "ENTITIES_LOCATIONS": "Dynamic.PocInsights.Locations.Location",
    "ENTITIES_GENERAL": "Dynamic.PocInsights.GeneralItems.Item",
    "ACTIONS": "Dynamic.PocInsights.Actions.Action",
    "OCR": "Dynamic.PocOcr",
  },
  "Metadata": {
    "Descriptive": {
        "Title": "My object",
        ...
    }
  }
}

...

POST insights/

Returns the list of available insights on the object

...

The input uses the following HTTP parameters

...

JSON properties

Property

Type

Description

recordIdRecordId

String

The record ID of the object in question

includeRawDataIncludeRawData

Boolean

Whether to include the raw data, by default false.

<mapping>Config

Object

The custom properties configured on the plugin are passed as a sequence of parameters → , as described above: https://mediahaven.atlassian.net/wiki/spaces/CS/pages/44388843954652335133/Module+Plugins#Custom-propertiesInsights+Connector+Contract#Configuration

Response / Output

  • 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

Type

Description

Metadata

The 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
titleInput & Output

Input

Code Block
languagejson
{
  "Config": {
    "SUMMARY": "Dynamic.PocInsights.Summary",
    "ENTITIES_PERSONS": "Dynamic.PocInsights.Persons.Person",
    "ENTITIES_ORGANISATIONS": "Dynamic.PocInsights.Organisations.Organisation",
    "ENTITIES_LOCATIONS": "Dynamic.PocInsights.Locations.Location",
    "ENTITIES_GENERAL": "Dynamic.PocInsights.GeneralItems.Item",
    "ACTIONS": "Dynamic.PocInsights.Actions.Action",
    "OCR": "Dynamic.PocOcr",
  },
  "RecordId": "<your Record ID>",
  "IncludeRawData": true
}

Output

Code Block
languagejson

{
  "Metadata":  {
    "Dynamic": {
      "InsightsPoc": {
        "Summary": "This is the summary of your document...",
        "EntitiesOrganisations": {
          "Organisation": ["The European Parliament", "Zeticon", ...]
        },
        "EntitiesLocations": {
          "Location": ["The European Parliament", "Zeticon", ...]
        },
        "EntitiesOrganisations": {
          "Organisation": ["The European Parliament", "Zeticon", ...]
        },
        "EntitiesLocations": {
          "Location": ["Gent", "Antwerp", ...]
        },
        "EntitiesGeneralItems": {
          "Item": ["Document", "Paper", ...]
        },
        "Actions": {
          "Action": ["voorstellen", "afwerken", ...]
        }
      }
    }
  },
  "RawData": <RAW DATA>
}