Informazioni sullo schema del contratto

Gli arricchimenti del contratto vengono applicati al campo html dei documenti che vengono aggiunti al progetto.

Dopo che un documento è stato elaborato dall'arricchimento dei contratti, il servizio genera un output JSON nel seguente schema:

{
  "elements": [
    {
      "location": {
        "begin": int,
        "end": int
      },
      "text": string,
      "types": [
        {
          "label": { "nature": string, "party": string },
          "provenance_ids": [string, string, ...]
            ...
          ]
        }
        ...
      ],
      "categories": [
        {
          "label": string,
          "provenance_ids": [string, string, ...]
        }
        ...
      ],
      "attributes": [
        {
          "type": string,
          "text": string,
          "location": { "begin": int, "end": int }
         }
      ]
    }
    ...
  ],
  "effective_dates": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
     },
     ...
  ],
  "contract_amounts": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "termination_dates": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_types": [
    {
      "confidence_level": string,
      "text": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_terms": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "payment_terms": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_currencies": [
    {
      "confidence_level" : string,
      "text" : string,
      "text_normalized" : string,
      "provenance_ids": [string, string ..],
      "location": { "begin": int, "end": int }
    },
  ...
],
  "tables": [],
  "document_structure": {
    "section_titles": [
      {
        "text": string,
        "location": {
          "begin": int,
          "end": int
        },
        "level": int,
        "element_locations": [
          {
            "begin": int,
            "end": int
          },
          ...
        ]
      },
      ...
    ],
    "leading_sentences": [
      {
        "text": string,
        "location": {
          "begin": int,
          "end": int
        },
        "element_locations": [
          {
            "begin": int,
            "end": int
          },
          ...
        ],
    "paragraphs": [
      {
        "location": {
           "begin": int,
           "end": int
         }
      },
      ...
    ]
      },
      ...
    ]
  },
  "parties": [
    {
      "party": string,
      "role": string,
      "importance": string,
      "addresses": [
        {
          "text": string,
          "location": {
            "begin": int,
            "end": int
          }
        },
        ...
      ],
      "contacts": [
        {
          "name": string,
          "role": string
        },
        ...
      ],
      "mentions": [
        {
          "text": string,
          "location": {
            "begin": int,
            "end": int
          }
        },
        ...
      ]
    },
    ...
  ]
}

Disposizione dello schema

Lo schema contracts è disposto nel seguente modo:

• elements: un array degli elementi del documento rilevati dal servizio.

  • location: un oggetto che identifica l'ubicazione dell'elemento. L'oggetto contiene due numeri di indice, begin e end. I numeri di indice indicano le posizioni iniziali e finali dei caratteri che costituiscono l'elemento in HTML.

  • text: il testo dell'elemento.

  • types: un array che descrive cos'è l'elemento e chi ne è interessato.

    • label: un oggetto che definisce il tipo utilizzando una coppia dei seguenti elementi:

      • nature: il tipo di azione che la frase richiede. I valori correnti sono Definition, Disclaimer, Exclusion, Obligation e Right.
      • party: una stringa che identifica la parte a cui si applica la frase.

    • provenance_ids: un array di uno o più valori con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

  • categories: un array che elenca le categorie funzionali in cui rientra l'elemento; in altre parole, l'oggetto dell'elemento.

    • label: una stringa che elenca la categoria identificata. Per un elenco di categorie, vedere Categorie.
    • provenance_ids: un array di uno o più valori con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

  • attributes: un array che identifica gli attributi del documento. Ogni oggetto nell'array è composto da tre elementi:

    • type: il tipo di attributo. I valori possibili sono Currency, DateTime, Duration, Location, Number, Organization, Percentage e Person come descritto in Attributi.
    • text: il testo associato all'attributo.
    • location: l'ubicazione dell'attributo come definita dai relativi indici begin e end.

• effective_dates: un array che identifica la data o le date in cui il documento diventa effettivo.

  • confidence_level: il livello di affidabilità dell'identificazione della data effettiva. I valori possibili includono High, Medium e Low.
  • text: una data effettiva, che viene elencata come una stringa.
  • text_normalized: il formato normalizzato della data effettiva, che viene elencata come una stringa. Questo elemento è facoltativo; vale a dire che l'output del servizio lo elenca solo se esiste un testo normalizzato.
  • location: l'ubicazione della data come definita dai relativi indici begin ed end.
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

• contract_amounts: un array con cui gli importi monetari identificano l'importo totale del contratto che deve essere pagato da una parte a un'altra.

  • confidence_level: il livello di affidabilità dell'identificazione dell'importo del contratto. I valori possibili includono High, Medium e Low.
  • text: un importo del contratto, elencato come una stringa.
  • location: l'ubicazione dell'importo o degli importi come definiti dai relativi indici begin e end.
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

• termination_dates: un array che identifica la data o le date in cui il documento deve essere terminato.

  • confidence_level: il livello di affidabilità dell'identificazione della data di terminazione. I valori possibili includono High, Medium e Low.
  • text: una data di terminazione, che è elencata come una stringa.
  • text_normalized: il formato normalizzato della data di terminazione, che viene elencata come una stringa. Questo elemento è facoltativo; vale a dire che l'output del servizio lo elenca solo se esiste un testo normalizzato.
  • location: l'ubicazione della data come definita dai relativi indici begin ed end.
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

• contract_types: un array che identifica il tipo o i tipi di contratto del documento.

  • confidence_level: il livello di affidabilità dell'identificazione del tipo di contratto. I valori possibili includono High, Medium e Low.
  • text: un tipo di contratto, elencato come una stringa.
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.
  • location: l'ubicazione del tipo di contratto come definita dai relativi indici begin ed end.

• contract_terms: un array che identifica la durata o le durate del contratto.

  • confidence_level: il livello di affidabilità dell'identificazione dei termini del contratto. I valori possibili includono High, Medium e Low.
  • text: un termine del contratto, elencato come una stringa.
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.
  • location: l'ubicazione del termine del contratto come definita dai relativi indici begin ed end.

• payment_terms: un array che identifica la durata o le durate del pagamento del documento.

  • confidence_level: il livello di affidabilità dell'identificazione del termine di pagamento. I valori possibili includono High, Medium e Low.

  • text: un termine di pagamento, elencato come una stringa.

  • text_normalized: il testo normalizzato, se applicabile.

  • interpretation: i dettagli del testo normalizzato, se applicabile.

    • value: una stringa che elenca il valore trovato nel testo normalizzato.

    • numeric_value: un numero intero o doppio che esprime il valore numerico della chiave value.

    • unit: una stringa che elenca l'unità del valore trovato nel testo normalizzato.

      Il valore di unit è il codice valuta dell' ISO-4217 e identificato per l'importo in valuta (ad esempio, USD o EUR ). Se il servizio non può disambiguare un simbolo di valuta (ad esempio, $ o £), il simbolo ambiguo stesso viene memorizzato come valore unit.

  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.

  • location: l'ubicazione del termine del contratto come definita dai relativi indici begin ed end.

• contract_currencies: Una matrice che identifica la valuta o le valute del contratto del documento.

  • confidence_level: il livello di affidabilità dell'identificazione della valuta del contratto. I valori possibili includono High, Medium e Low.
  • text: la valuta di un contratto, elencata come una stringa.
  • text_normalized: il testo normalizzato, se applicabile. È elencato come stringa in ISO-4217 formato
  • provenance_ids: un array che contiene zero o più chiavi. Ciascuna chiave è un valore con hash che puoi inviare a IBM per fornire un feedback o ricevere supporto.
  • location: l'ubicazione della valuta del contratto come definita dai relativi indici begin ed end.

• document_structure: un oggetto che descrive la struttura del documento di input.

  • section_titles: un array che contiene un singolo oggetto per ogni sezione o sottosezione rilevata nel documento di input. Le sezioni e le sottosezioni non sono nidificate. Esse sono invece rese flat e possono essere rimesse in ordine utilizzando i valori begin ed end dell'elemento e il valore level della sezione.

    • text: una stringa che elenca il titolo di sezione, se rilevato.
    • location: l'ubicazione del titolo nel documento di input come definita dai relativi indici begin e end.
    • level: un numero intero che indica il livello al quale si trova la sezione nel documento di input. Ad esempio, rappresenta una sezione di livello radice, rappresenta una sottosezione all'interno della sezione di livello.
    • element_locations: un array che specifica i valori begin ed end delle frasi nella sezione.

  • leading_sentences: un array che contiene un oggetto per ogni frase principale di un elenco o di una sottosezione, in parallelo con gli array section_titles e paragraph. L'oggetto descrive le frasi principali nella sezione o sottosezione corrispondente. Come nell'array section_titles, gli oggetti non sono nidificati. Invece, sono appiattiti e possono essere rimessi in ordine utilizzando i valori di " begin " e " end " dell'elemento o qualsiasi indicatore di livello nel documento di input.

    • text: una stringa che elenca la frase principale, se rilevata.
    • location: l'ubicazione della frase principale nel documento di input come definita dai relativi indici begin e end.
    • element_locations: un array che specifica i valori begin ed end delle frasi principali nella sezione.

  • paragraphs: Un array che contiene un oggetto per paragrafo, in parallelo con gli array section_titles e leading_sentences. Ogni oggetto elenca l'estensione (ubicazione di inizio e fine) del paragrafo corrispondente.

    • location: l'ubicazione del paragrafo nel documento di input come definita dai relativi indici begin ed end.

• parties: un array che definisce le parti identificate dal servizio.

  • party: una stringa che fornisce il formato normalizzato del nome della parte.

  • role: una stringa che identifica il ruolo della parte.

  • importance: una stringa che identifica l'importanza della parte. I valori possibili includono Primary per una parte primaria e Unknown per una parte non primaria.

  • addresses: un array di oggetti che identifica gli indirizzi.

    • text: una stringa che contiene l'indirizzo.
    • location: l'ubicazione dell'indirizzo come definita dai relativi indici begin e end.

  • contacts: un array che definisce il nome e il ruolo dei contatti identificati nel documento di input.

    • name: una stringa che elenca il nome di un contatto identificato.
    • role: una stringa che elenca il ruolo del contatto identificato.

  • mentions: un array di oggetti che identificano citazioni della parte.

    • text: una stringa che elenca il nome della parte.
    • location: l'ubicazione della citazione come definita dai relativi indici begin e end.

{
  ...
  "location": {
    "begin": 2510,
    "end": 2519
  }
  ...
}

document_structure

L'output dell'arricchimento Contracts include un oggetto document_structure che indica in dettaglio la composizione strutturale del documento di input. Le informazioni sulla struttura del documento vengono rappresentate nel seguente esempio JSON. L'oggetto si trova immediatamente dopo l'array di radice ( tables ).

"document_structure": {
  "section_titles": [
    {
      "text": string,
      "location": {
        "begin": int,
        "end": int
      },
      "level": int
      "element_locations": [
        {
          "begin": int,
          "end": int
        },
        ...
      ]
    },
    ...
  ],
  "leading_sentences": [
    {
      "text": string,
      "location": {
        "begin": int,
        "end": int
      },
      "element_locations": [
        {
          "begin": int,
          "end": int
        },
        ...
      ]
    },
    ...
  ],
  "paragraphs": [
    {
      "location": {
        "begin": int,
        "end": int
      }
    },
    ...
  ]
}

Elementi

L'arricchimento del contratto genera un'analisi di ciascun elemento identificato nel contratto. Le seguenti sezioni descrivono ogni tipo di elemento generato.