Structures
The following structures are available globally.
-
A party’s address.
See moreDeclaration
Swift
public struct Address : Codable, Equatable
-
AlignedElement.
See moreDeclaration
Swift
public struct AlignedElement : Codable, Equatable
-
List of document attributes.
See moreDeclaration
Swift
public struct Attribute : Codable, Equatable
-
The batch-request status.
See moreDeclaration
Swift
public struct BatchStatus : Codable, Equatable
-
The results of a successful List Batches request.
See moreDeclaration
Swift
public struct Batches : Codable, Equatable
-
Cells that are not table header, column header, or row header cells.
See moreDeclaration
Swift
public struct BodyCells : Codable, Equatable
-
Information defining an element’s subject matter.
See moreDeclaration
Swift
public struct Category : Codable, Equatable
-
Information defining an element’s subject matter.
See moreDeclaration
Swift
public struct CategoryComparison : Codable, Equatable
-
The analysis of objects returned by the Element classification method.
See moreDeclaration
Swift
public struct ClassifyReturn : Codable, Equatable
-
Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.
See moreDeclaration
Swift
public struct ColumnHeaders : Codable, Equatable
-
The comparison of the two submitted documents.
See moreDeclaration
Swift
public struct CompareReturn : Codable, Equatable
-
A contact.
See moreDeclaration
Swift
public struct Contact : Codable, Equatable
-
Text that is related to the contents of the table and that precedes or follows the current table.
See moreDeclaration
Swift
public struct Contexts : Codable, Equatable
-
A monetary amount identified in the input document.
See moreDeclaration
Swift
public struct ContractAmts : Codable, Equatable
-
The contract currencies that are declared in the document.
See moreDeclaration
Swift
public struct ContractCurrencies : Codable, Equatable
-
The duration or durations of the contract.
See moreDeclaration
Swift
public struct ContractTerms : Codable, Equatable
-
The contract type identified in the input document.
See moreDeclaration
Swift
public struct ContractTypes : Codable, Equatable
-
Document counts.
See moreDeclaration
Swift
public struct DocCounts : Codable, Equatable
-
Information about the parsed input document.
See moreDeclaration
Swift
public struct DocInfo : Codable, Equatable
-
The structure of the input document.
See moreDeclaration
Swift
public struct DocStructure : Codable, Equatable
-
Basic information about the input document.
See moreDeclaration
Swift
public struct Document : Codable, Equatable
-
An effective date.
See moreDeclaration
Swift
public struct EffectiveDates : Codable, Equatable
-
A component part of the document.
See moreDeclaration
Swift
public struct Element : Codable, Equatable
-
A list of
See morebegin
andend
indexes that indicate the locations of the elements in the input document.Declaration
Swift
public struct ElementLocations : Codable, Equatable
-
Details of semantically aligned elements.
See moreDeclaration
Swift
public struct ElementPair : Codable, Equatable
-
Feedback data for submission.
See moreDeclaration
Swift
public struct FeedbackDataInput : Codable, Equatable
-
Information returned from the Add Feedback method.
See moreDeclaration
Swift
public struct FeedbackDataOutput : Codable, Equatable
-
The status and message of the deletion request.
See moreDeclaration
Swift
public struct FeedbackDeleted : Codable, Equatable
-
The results of a successful List Feedback request for all feedback.
See moreDeclaration
Swift
public struct FeedbackList : Codable, Equatable
-
Information about the document and the submitted feedback.
See moreDeclaration
Swift
public struct FeedbackReturn : Codable, Equatable
-
The results of a successful Get Feedback request for a single feedback entry.
See moreDeclaration
Swift
public struct GetFeedback : Codable, Equatable
-
The HTML converted from an input document.
See moreDeclaration
Swift
public struct HTMLReturn : Codable, Equatable
-
The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists.
See moreDeclaration
Swift
public struct Interpretation : Codable, Equatable
-
A key in a key-value pair.
See moreDeclaration
Swift
public struct Key : Codable, Equatable
-
Key-value pairs detected across cell boundaries.
See moreDeclaration
Swift
public struct KeyValuePair : Codable, Equatable
-
A pair of
See morenature
andparty
objects. Thenature
object identifies the effect of the element on the identifiedparty
, and theparty
object identifies the affected party.Declaration
Swift
public struct Label : Codable, Equatable
-
The leading sentences in a section or subsection of the input document.
See moreDeclaration
Swift
public struct LeadingSentence : Codable, Equatable
-
The numeric location of the identified element in the document, represented with two integers labeled
See morebegin
andend
.Declaration
Swift
public struct Location : Codable, Equatable
-
A mention of a party.
See moreDeclaration
Swift
public struct Mention : Codable, Equatable
-
The original labeling from the input document, without the submitted feedback.
See moreDeclaration
Swift
public struct OriginalLabelsIn : Codable, Equatable
-
The original labeling from the input document, without the submitted feedback.
See moreDeclaration
Swift
public struct OriginalLabelsOut : Codable, Equatable
-
Pagination details, if required by the length of the output.
See moreDeclaration
Swift
public struct Pagination : Codable, Equatable
-
The locations of each paragraph in the input document.
See moreDeclaration
Swift
public struct Paragraphs : Codable, Equatable
-
A party and its corresponding role, including address and contact information if identified.
See moreDeclaration
Swift
public struct Parties : Codable, Equatable
-
The document’s payment duration or durations.
See moreDeclaration
Swift
public struct PaymentTerms : Codable, Equatable
-
Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.
See moreDeclaration
Swift
public struct RowHeaders : Codable, Equatable
-
The table’s section title, if identified.
See moreDeclaration
Swift
public struct SectionTitle : Codable, Equatable
-
An array containing one object per section or subsection detected in the input document. Sections and subsections are not nested; instead, they are flattened out and can be placed back in order by using the
See morebegin
andend
values of the element and thelevel
value of the section.Declaration
Swift
public struct SectionTitles : Codable, Equatable
-
Brief information about the input document.
See moreDeclaration
Swift
public struct ShortDoc : Codable, Equatable
-
The contents of the current table’s header.
See moreDeclaration
Swift
public struct TableHeaders : Codable, Equatable
-
The analysis of the document’s tables.
See moreDeclaration
Swift
public struct TableReturn : Codable, Equatable
-
If identified, the title or caption of the current table of the form
See moreTable x.: ...
. Empty when no title is identified. When exposed, thetitle
is also excluded from thecontexts
array of the same table.Declaration
Swift
public struct TableTitle : Codable, Equatable
-
The contents of the tables extracted from a document.
See moreDeclaration
Swift
public struct Tables : Codable, Equatable
-
Termination dates identified in the input document.
See moreDeclaration
Swift
public struct TerminationDates : Codable, Equatable
-
Identification of a specific type.
See moreDeclaration
Swift
public struct TypeLabel : Codable, Equatable
-
Identification of a specific type.
See moreDeclaration
Swift
public struct TypeLabelComparison : Codable, Equatable
-
Element that does not align semantically between two compared documents.
See moreDeclaration
Swift
public struct UnalignedElement : Codable, Equatable
-
The updated labeling from the input document, accounting for the submitted feedback.
See moreDeclaration
Swift
public struct UpdatedLabelsIn : Codable, Equatable
-
The updated labeling from the input document, accounting for the submitted feedback.
See moreDeclaration
Swift
public struct UpdatedLabelsOut : Codable, Equatable
-
A value in a key-value pair.
See moreDeclaration
Swift
public struct Value : Codable, Equatable