Informationen zum Vertragsschema

Vertragsaufbereitungen werden auf das Feld html von Dokumenten angewendet, die dem Projekt hinzugefügt werden.

Nachdem ein Dokument von der Vertragsanreicherung verarbeitet wurde, generiert der Dienst eine JSON-Ausgabe im folgenden 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
          }
        },
        ...
      ]
    },
    ...
  ]
}

Schemaanordnung

Das Vertragsschema (contracts) ist wie folgt angeordnet.

• elements: Ein Array mit den Dokumentelementen, die vom Service erkannt wurden.

  • location: Ein Objekt, das die Position des Elements angibt. Das Objekt enthält die beiden Indexzahlen begin und end. Die Indexnummern geben die Anfangs-und Endposition der Zeichen an, die das Element in HTML bilden.

  • text: Der Text des Elements.

  • types: Ein Array, das die Art des Elements und dessen Auswirkungen beschreibt.

    • label: Ein Objekt, dass den Typ anhand eines Paares definiert, das sich aus den folgenden Elementen zusammensetzen kann:

      • nature: Der Typ der Aktion, der für den Satz erforderlich ist. Die aktuellen Werte sind Definition, Disclaimer, Exclusion, Obligation und Right.
      • party: Eine Zeichenfolge, die die Partei angibt, auf die der Satz anwendbar ist.

    • provenance_ids: Ein Array aus einem oder mehreren Hashwerten, die Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

  • categories: Ein Array, in dem die funktionalen Kategorien aufgelistet sind, in die das Element fällt; in anderen Worten, der Inhalt des Elements.

    • label: Eine Zeichenfolge, die die angegebene Kategorie auflistet. Eine Liste der Kategorien finden Sie unter Kategorien.
    • provenance_ids: Ein Array aus einem oder mehreren Hashwerten, die Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

  • attributes: Ein Array, das Dokumentattribute angibt. Jedes Objekt in dem Array besteht aus drei Elementen:

    • type: Der Typ von Attribut. Gültige Werte sind Currency, DateTime, Duration, Location, Number, Organization, Percentage und Person (siehe Beschreibung unter Attribute).
    • text: Der Text, der dem Attribut zugeordnet ist.
    • location: Die Position des Attributs, wie durch die Indizes begin und end definiert.

• effective_dates: Ein Array, das den oder die Zeitpunkt(e) angibt, zu dem bzw. zu denen das Dokument gültig wird.

  • confidence_level: Das Konfidenzniveau der Identifizierung des Gültigkeitsdatums. Mögliche Werte sind High, Medium und Low.
  • text: Ein Gültigkeitsdatum in Form einer Zeichenfolge.
  • text_normalized: Das Gültigkeitsdatum in normalisiertem Format, das als Zeichenfolge aufgelistet wird. Dieses Element ist optional, sodass der Service nur Listen ausgibt, wenn normalisierter Text vorhanden ist.
  • location: Die Position des Datums, wie durch die Indizes begin und end definiert.
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

• contract_amounts: Ein Array mit Geldbeträgen, die den Gesamtbetrag des Vertrags angeben, der von einer Partei an eine andere zu zahlen ist.

  • confidence_level: Das Konfidenzniveau der Identifizierung des Vertragsbetrags. Mögliche Werte sind High, Medium und Low.
  • text: Ein Vertragsbetrag in Form einer Zeichenfolge.
  • location: Die Position des Betrags oder der Beträge, wie durch die Indizes begin und end definiert.
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

• termination_dates: Ein Array, das den oder die Zeitpunkt(e) angibt, zu dem bzw. zu denen die Gültigkeit des Dokuments enden soll.

  • confidence_level: Das Konfidenzniveau der Identifizierung des Beendigungsdatums. Mögliche Werte sind High, Medium und Low.
  • text: Ein Beendigungsdatum in Form einer Zeichenfolge.
  • text_normalized: Das Beendigungsdatum in normalisiertem Format, das als Zeichenfolge aufgelistet wird. Dieses Element ist optional, sodass der Service nur Listen ausgibt, wenn normalisierter Text vorhanden ist.
  • location: Die Position des Datums, wie durch die Indizes begin und end definiert.
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

• contract_types: Ein Array, das den oder die Vertragstypen des Dokuments angibt.

  • confidence_level: Das Konfidenzniveau der Identifizierung des Vertragstyps. Mögliche Werte sind High, Medium und Low.
  • text: Ein Vertragstyp in Form einer Zeichenfolge.
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.
  • location: Die Position des Vertragstyps, wie durch die Indizes begin und end definiert.

• contract_terms: Ein Array, das die Laufzeit bzw. Laufzeiten des Vertrags angibt.

  • confidence_level: Das Konfidenzniveau der Identifizierung der Vertragsbedingungen. Mögliche Werte sind High, Medium und Low.
  • text: Eine Vertragslaufzeit in Form einer Zeichenfolge.
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.
  • location: Die Position der Vertragslaufzeit, wie durch die Indizes begin und end definiert.

• payment_terms: Ein Array, das die Zahlungslaufzeit(en) des Dokuments angibt.

  • confidence_level: Das Konfidenzniveau der Identifizierung der Zahlungslaufzeit. Mögliche Werte sind High, Medium und Low.

  • text: Eine Zahlungsbedingung in Form einer Zeichenfolge.

  • text_normalized: Der normalisierte Text, sofern zutreffend.

  • interpretation: Die Details des normalisierten Texts, sofern zutreffend.

    • value: Eine Zeichenfolge mit Auflistung des Werts, der im normalisierten Text gefunden wurde.

    • numeric_value: Ein Integer- oder Double-Wert, der den numerischen Wert des Schlüssels value ausdrückt.

    • unit: Eine Zeichenfolge, die die Einheit für den Wert im normalisierten Text angibt.

      Der Wert von unit ist der Währungscode ISO-4217, der für den Währungsbetrag angegeben wird (z. B. USD oder EUR ). Wenn der Service ein Währungssymbol (z. B. $ oder £) nicht eindeutig identifizieren kann, wird das mehrdeutige Symbol selbst als unit-Wert gespeichert.

  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.

  • location: Die Position der Vertragslaufzeit, wie durch die Indizes begin und end definiert.

• contract_currencies: Ein Array, das die Vertragswährung(en) des Dokuments angibt.

  • confidence_level: Das Konfidenzniveau der Identifizierung der Vertragswährung. Mögliche Werte sind High, Medium und Low.
  • text: Eine Vertragswährung in Form einer Zeichenfolge.
  • text_normalized: Der normalisierte Text, sofern zutreffend. Es wird als Zeichenkette im ISO-4217 format
  • provenance_ids: Ein Array, das null oder mehr Schlüssel enthält. Jeder Schlüssel ist ein Hashwert, den Sie an IBM senden können, um Feedback zu geben oder Unterstützung zu erhalten.
  • location: Die Position der Vertragswährung, wie durch die Indizes begin und end definiert.

• document_structure: Ein Objekt, das die Struktur des Eingabedokuments beschreibt.

  • section_titles: Ein Array, das ein Objekt pro Abschnitt oder Unterabschnitt enthält, der im Eingabedokument erkannt wurde. Schnitte und Unterabschnitte sind nicht ineinander verschachtelt. Sie sind flach angeordnet und können mit den Werten für begin und end des Elements und dem Wert für level des Abschnitts wieder zurück in die richtige Reihenfolge gebracht werden.

    • text: Eine Zeichenfolge, die den Abschnittstitel auflistet (falls gefunden).
    • location: Die Position des Titels im Eingabedokument, wie durch die Indizes begin und end definiert.
    • level: Eine ganze Zahl, die die Ebene angibt, auf der sich der Abschnitt im Eingabedokument befindet. Zum Beispiel steht für einen Abschnitt auf der obersten Ebene, steht für einen Unterabschnitt innerhalb des Abschnitts auf der obersten Ebene.
    • element_locations: Ein Array, das die Werte für begin und end der Sätze im Abschnitt angibt.

  • leading_sentences: Ein Array, das ein Objekt pro führendem Satz einer Liste oder eines Unterabschnitts enthält (parallel zu den Arrays section_titles und paragraph). Das Objekt beschreibt die führenden Sätze im entsprechenden Abschnitt oder Unterabschnitt detailliert. Wie im Array section_titles sind die Objekte nicht verschachtelt. Stattdessen werden sie abgeflacht und können mithilfe der begin- und end-Werte des Elements oder beliebiger Ebenenmarkierungen im Eingabedokument wieder in die richtige Reihenfolge gebracht werden.

    • text: Eine Zeichenfolge, die den führenden Satz auflistet (falls gefunden).
    • location: Die Position des führenden Satzes im Eingabedokument, wie durch die Indizes begin und end definiert.
    • element_locations: Ein Array, das die Werte für begin und end der führenden Sätze im Abschnitt angibt.

  • paragraphs: Eine Anordnung, die ein Objekt pro Absatz enthält, parallel zu den Anordnungen section_titles und leading_sentences. Jedes Objekt listet den Bereich (Anfangs- und Endposition) des entsprechenden Absatzes auf.

    • location: Die Position des Absatzes im Eingabedokument, wie durch die Indizes begin und end definiert.

• parties: Ein Array, das die vom Service angegebenen Parteien definiert.

  • party: Eine Zeichenfolge, die die normalisierte Form des Namens der Partei bereitstellt.

  • role: Eine Zeichenfolge, die die Rolle der Partei angibt.

  • importance: Eine Zeichenfolge, die die Wichtigkeit der Partei angibt. Mögliche Werte sind Primary für eine Primärpartei oder Unknown für eine Nicht-Primärpartei.

  • addresses: Ein Array von Objekten, die Adressen angeben.

    • text: Eine Zeichenfolge, die die Adresse enthält.
    • location: Die Position der Adresse, wie durch die Indizes begin und end definiert.

  • contacts: Ein Array, das den Namen und die Rolle von Kontakten definiert, die im Eingabedokument angegeben sind.

    • name: Eine Zeichenfolge, die den Namen eines angegebenen Kontakts auflistet.
    • role: Eine Zeichenfolge, die die Rolle des angegebenen Kontakts auflistet.

  • mentions: Ein Array von Objekten, das Erwähnungen der Partei angibt.

    • text: Eine Zeichenfolge, die den Namen der Partei auflistet.
    • location: Die Position der Erwähnung, wie durch die Indizes begin und end definiert.

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

Dokumentstruktur

Teil der Ausgabe der Aufbereitung Contracts ist ein Objekt document_structure mit den Details des strukturellen Aufbaus des Eingabedokuments. Die Dokumentstrukturinformationen werden im folgenden JSON-Beispiel dargestellt. Das Objekt befindet sich unmittelbar nach dem tables-Array auf Root-Ebene.

"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
      }
    },
    ...
  ]
}

Elemente

Die Vertragsaufbereitung generiert eine Analyse jedes identifizierten Elements im Vertrag. In den folgenden Abschnitten werden alle generierten Elementtypen beschrieben.