comparecomplyv1

type AddFeedbackOptions struct {

	// Feedback data for submission.
	FeedbackData *FeedbackDataInput `json:"feedback_data" validate:"required"`

	// An optional string identifying the user.
	UserID *string `json:"user_id,omitempty"`

	// An optional comment on or description of the feedback.
	Comment *string `json:"comment,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type Address struct {

	// A string listing the address.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type AlignedElement struct {

	// Identifies two elements that semantically align between the compared documents.
	ElementPair []ElementPair `json:"element_pair,omitempty"`

	// Specifies whether the aligned element is identical. Elements are considered identical despite minor differences such
	// as leading punctuation, end-of-sentence punctuation, whitespace, the presence or absence of definite or indefinite
	// articles, and others.
	IdenticalText *bool `json:"identical_text,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// Indicates that the elements aligned are contractual clauses of significance.
	SignificantElements *bool `json:"significant_elements,omitempty"`
}

type Attribute struct {

	// The type of attribute.
	Type *string `json:"type,omitempty"`

	// The text associated with the attribute.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type BatchStatus struct {

	// The method to be run against the documents. Possible values are `html_conversion`, `element_classification`, and
	// `tables`.
	Function *string `json:"function,omitempty"`

	// The geographical location of the Cloud Object Storage input bucket as listed on the **Endpoint** tab of your COS
	// instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.
	InputBucketLocation *string `json:"input_bucket_location,omitempty"`

	// The name of the Cloud Object Storage input bucket.
	InputBucketName *string `json:"input_bucket_name,omitempty"`

	// The geographical location of the Cloud Object Storage output bucket as listed on the **Endpoint** tab of your COS
	// instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.
	OutputBucketLocation *string `json:"output_bucket_location,omitempty"`

	// The name of the Cloud Object Storage output bucket.
	OutputBucketName *string `json:"output_bucket_name,omitempty"`

	// The unique identifier for the batch request.
	BatchID *string `json:"batch_id,omitempty"`

	// Document counts.
	DocumentCounts *DocCounts `json:"document_counts,omitempty"`

	// The status of the batch request.
	Status *string `json:"status,omitempty"`

	// The creation time of the batch request.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The time of the most recent update to the batch request.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

type Batches struct {

	// A list of the status of all batch requests.
	Batches []BatchStatus `json:"batches,omitempty"`
}

type BodyCells struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`

	// An array that contains the `id` value of a row header that is applicable to this body cell.
	RowHeaderIds []string `json:"row_header_ids,omitempty"`

	// An array that contains the `text` value of a row header that is applicable to this body cell.
	RowHeaderTexts []string `json:"row_header_texts,omitempty"`

	// If you provide customization input, the normalized version of the row header texts according to the customization;
	// otherwise, the same value as `row_header_texts`.
	RowHeaderTextsNormalized []string `json:"row_header_texts_normalized,omitempty"`

	// An array that contains the `id` value of a column header that is applicable to the current cell.
	ColumnHeaderIds []string `json:"column_header_ids,omitempty"`

	// An array that contains the `text` value of a column header that is applicable to the current cell.
	ColumnHeaderTexts []string `json:"column_header_texts,omitempty"`

	// If you provide customization input, the normalized version of the column header texts according to the
	// customization; otherwise, the same value as `column_header_texts`.
	ColumnHeaderTextsNormalized []string `json:"column_header_texts_normalized,omitempty"`

	Attributes []Attribute `json:"attributes,omitempty"`
}

type Category struct {

	// The category of the associated element.
	Label *string `json:"label,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`
}

type CategoryComparison struct {

	// The category of the associated element.
	Label *string `json:"label,omitempty"`
}

type ClassifyElementsOptions struct {

	// The document to classify.
	File io.ReadCloser `json:"file" validate:"required"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type ClassifyReturn struct {

	// Basic information about the input document.
	Document *Document `json:"document,omitempty"`

	// The analysis model used to classify the input document. For the **Element classification** method, the only valid
	// value is `contracts`.
	ModelID *string `json:"model_id,omitempty"`

	// The version of the analysis model identified by the value of the `model_id` key.
	ModelVersion *string `json:"model_version,omitempty"`

	// Document elements identified by the service.
	Elements []Element `json:"elements,omitempty"`

	// The date or dates on which the document becomes effective.
	EffectiveDates []EffectiveDates `json:"effective_dates,omitempty"`

	// The monetary amounts that identify the total amount of the contract that needs to be paid from one party to another.
	ContractAmounts []ContractAmts `json:"contract_amounts,omitempty"`

	// The dates on which the document is to be terminated.
	TerminationDates []TerminationDates `json:"termination_dates,omitempty"`

	// The contract type as declared in the document.
	ContractTypes []ContractTypes `json:"contract_types,omitempty"`

	// The durations of the contract.
	ContractTerms []ContractTerms `json:"contract_terms,omitempty"`

	// The document's payment durations.
	PaymentTerms []PaymentTerms `json:"payment_terms,omitempty"`

	// The contract currencies as declared in the document.
	ContractCurrencies []ContractCurrencies `json:"contract_currencies,omitempty"`

	// Definition of tables identified in the input document.
	Tables []Tables `json:"tables,omitempty"`

	// The structure of the input document.
	DocumentStructure *DocStructure `json:"document_structure,omitempty"`

	// Definitions of the parties identified in the input document.
	Parties []Parties `json:"parties,omitempty"`
}

type ColumnHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The location of the column header cell in the current table as defined by its `begin` and `end` offsets,
	// respectfully, in the input document.
	Location interface{} `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// If you provide customization input, the normalized version of the cell text according to the customization;
	// otherwise, the same value as `text`.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type CompareComplyV1 struct {
	Service *core.BaseService
	Version string
}

type CompareComplyV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
	Version       string
}

type CompareDocumentsOptions struct {

	// The first document to compare.
	File1 io.ReadCloser `json:"file_1" validate:"required"`

	// The second document to compare.
	File2 io.ReadCloser `json:"file_2" validate:"required"`

	// The content type of file1.
	File1ContentType *string `json:"file_1_content_type,omitempty"`

	// The content type of file2.
	File2ContentType *string `json:"file_2_content_type,omitempty"`

	// A text label for the first document.
	File1Label *string `json:"file_1_label,omitempty"`

	// A text label for the second document.
	File2Label *string `json:"file_2_label,omitempty"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type CompareReturn struct {

	// The analysis model used to compare the input documents. For the **Compare two documents** method, the only valid
	// value is `contracts`.
	ModelID *string `json:"model_id,omitempty"`

	// The version of the analysis model identified by the value of the `model_id` key.
	ModelVersion *string `json:"model_version,omitempty"`

	// Information about the documents being compared.
	Documents []Document `json:"documents,omitempty"`

	// A list of pairs of elements that semantically align between the compared documents.
	AlignedElements []AlignedElement `json:"aligned_elements,omitempty"`

	// A list of elements that do not semantically align between the compared documents.
	UnalignedElements []UnalignedElement `json:"unaligned_elements,omitempty"`
}

type Contact struct {

	// A string listing the name of the contact.
	Name *string `json:"name,omitempty"`

	// A string listing the role of the contact.
	Role *string `json:"role,omitempty"`
}

type Contexts struct {

	// The related text.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type ContractAmts struct {

	// The confidence level in the identification of the contract amount.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The monetary amount.
	Text *string `json:"text,omitempty"`

	// The normalized form of the amount, which is listed as a string. This element is optional; it is returned only if
	// normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text
	// exists.
	Interpretation *Interpretation `json:"interpretation,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type ContractCurrencies struct {

	// The confidence level in the identification of the contract currency.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The contract currency.
	Text *string `json:"text,omitempty"`

	// The normalized form of the contract currency, which is listed as a string in
	// [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format. This element is optional; it is returned only
	// if normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type ContractTerms struct {

	// The confidence level in the identification of the contract term.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The contract term (duration).
	Text *string `json:"text,omitempty"`

	// The normalized form of the contract term, which is listed as a string. This element is optional; it is returned only
	// if normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text
	// exists.
	Interpretation *Interpretation `json:"interpretation,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type ContractTypes struct {

	// The confidence level in the identification of the contract type.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The contract type.
	Text *string `json:"text,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type ConvertToHTMLOptions struct {

	// The document to convert.
	File io.ReadCloser `json:"file" validate:"required"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type CreateBatchOptions struct {

	// The Compare and Comply method to run across the submitted input documents.
	Function *string `json:"function" validate:"required"`

	// A JSON file containing the input Cloud Object Storage credentials. At a minimum, the credentials must enable `READ`
	// permissions on the bucket defined by the `input_bucket_name` parameter.
	InputCredentialsFile io.ReadCloser `json:"input_credentials_file" validate:"required"`

	// The geographical location of the Cloud Object Storage input bucket as listed on the **Endpoint** tab of your Cloud
	// Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.
	InputBucketLocation *string `json:"input_bucket_location" validate:"required"`

	// The name of the Cloud Object Storage input bucket.
	InputBucketName *string `json:"input_bucket_name" validate:"required"`

	// A JSON file that lists the Cloud Object Storage output credentials. At a minimum, the credentials must enable `READ`
	// and `WRITE` permissions on the bucket defined by the `output_bucket_name` parameter.
	OutputCredentialsFile io.ReadCloser `json:"output_credentials_file" validate:"required"`

	// The geographical location of the Cloud Object Storage output bucket as listed on the **Endpoint** tab of your Cloud
	// Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.
	OutputBucketLocation *string `json:"output_bucket_location" validate:"required"`

	// The name of the Cloud Object Storage output bucket.
	OutputBucketName *string `json:"output_bucket_name" validate:"required"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DeleteFeedbackOptions struct {

	// A string that specifies the feedback entry to be deleted from the document.
	FeedbackID *string `json:"feedback_id" validate:"required"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DocCounts struct {

	// Total number of documents.
	Total *int64 `json:"total,omitempty"`

	// Number of pending documents.
	Pending *int64 `json:"pending,omitempty"`

	// Number of documents successfully processed.
	Successful *int64 `json:"successful,omitempty"`

	// Number of documents not successfully processed.
	Failed *int64 `json:"failed,omitempty"`
}

type DocInfo struct {

	// The full text of the parsed document in HTML format.
	HTML *string `json:"html,omitempty"`

	// The title of the parsed document. If the service did not detect a title, the value of this element is `null`.
	Title *string `json:"title,omitempty"`

	// The MD5 hash of the input document.
	Hash *string `json:"hash,omitempty"`
}

type DocStructure struct {

	// An array containing one object per section or subsection identified in the input document.
	SectionTitles []SectionTitles `json:"section_titles,omitempty"`

	// An array containing one object per section or subsection, in parallel with the `section_titles` array, that details
	// the leading sentences in the corresponding section or subsection.
	LeadingSentences []LeadingSentence `json:"leading_sentences,omitempty"`

	// An array containing one object per paragraph, in parallel with the `section_titles` and `leading_sentences` arrays.
	Paragraphs []Paragraphs `json:"paragraphs,omitempty"`
}

type Document struct {

	// Document title, if detected.
	Title *string `json:"title,omitempty"`

	// The input document converted into HTML format.
	HTML *string `json:"html,omitempty"`

	// The MD5 hash value of the input document.
	Hash *string `json:"hash,omitempty"`

	// The label applied to the input document with the calling method's `file_1_label` or `file_2_label` value. This field
	// is specified only in the output of the **Comparing two documents** method.
	Label *string `json:"label,omitempty"`
}

type EffectiveDates struct {

	// The confidence level in the identification of the effective date.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The effective date, listed as a string.
	Text *string `json:"text,omitempty"`

	// The normalized form of the effective date, which is listed as a string. This element is optional; it is returned
	// only if normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type Element struct {

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text of the element.
	Text *string `json:"text,omitempty"`

	// Description of the action specified by the element  and whom it affects.
	Types []TypeLabel `json:"types,omitempty"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []Category `json:"categories,omitempty"`

	// List of document attributes.
	Attributes []Attribute `json:"attributes,omitempty"`
}

type ElementLocations struct {

	// An integer that indicates the starting position of the element in the input document.
	Begin *int64 `json:"begin,omitempty"`

	// An integer that indicates the ending position of the element in the input document.
	End *int64 `json:"end,omitempty"`
}

type ElementPair struct {

	// The label of the document (that is, the value of either the `file_1_label` or `file_2_label` parameters) in which
	// the element occurs.
	DocumentLabel *string `json:"document_label,omitempty"`

	// The contents of the element.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabelComparison `json:"types,omitempty"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []CategoryComparison `json:"categories,omitempty"`

	// List of document attributes.
	Attributes []Attribute `json:"attributes,omitempty"`
}

type ExtractTablesOptions struct {

	// The document on which to run table extraction.
	File io.ReadCloser `json:"file" validate:"required"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type FeedbackDataInput struct {

	// The type of feedback. The only permitted value is `element_classification`.
	FeedbackType *string `json:"feedback_type" validate:"required"`

	// Brief information about the input document.
	Document *ShortDoc `json:"document,omitempty"`

	// An optional string identifying the model ID. The only permitted value is `contracts`.
	ModelID *string `json:"model_id,omitempty"`

	// An optional string identifying the version of the model used.
	ModelVersion *string `json:"model_version,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location" validate:"required"`

	// The text on which to submit feedback.
	Text *string `json:"text" validate:"required"`

	// The original labeling from the input document, without the submitted feedback.
	OriginalLabels *OriginalLabelsIn `json:"original_labels" validate:"required"`

	// The updated labeling from the input document, accounting for the submitted feedback.
	UpdatedLabels *UpdatedLabelsIn `json:"updated_labels" validate:"required"`
}

type FeedbackDataOutput struct {

	// A string identifying the user adding the feedback. The only permitted value is `element_classification`.
	FeedbackType *string `json:"feedback_type,omitempty"`

	// Brief information about the input document.
	Document *ShortDoc `json:"document,omitempty"`

	// An optional string identifying the model ID. The only permitted value is `contracts`.
	ModelID *string `json:"model_id,omitempty"`

	// An optional string identifying the version of the model used.
	ModelVersion *string `json:"model_version,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text to which the feedback applies.
	Text *string `json:"text,omitempty"`

	// The original labeling from the input document, without the submitted feedback.
	OriginalLabels *OriginalLabelsOut `json:"original_labels,omitempty"`

	// The updated labeling from the input document, accounting for the submitted feedback.
	UpdatedLabels *UpdatedLabelsOut `json:"updated_labels,omitempty"`

	// Pagination details, if required by the length of the output.
	Pagination *Pagination `json:"pagination,omitempty"`
}

type FeedbackDeleted struct {

	// HTTP return code.
	Status *int64 `json:"status,omitempty"`

	// Status message returned from the service.
	Message *string `json:"message,omitempty"`
}

type FeedbackList struct {

	// A list of all feedback for the document.
	Feedback []GetFeedback `json:"feedback,omitempty"`
}

type FeedbackReturn struct {

	// The unique ID of the feedback object.
	FeedbackID *string `json:"feedback_id,omitempty"`

	// An optional string identifying the person submitting feedback.
	UserID *string `json:"user_id,omitempty"`

	// An optional comment from the person submitting the feedback.
	Comment *string `json:"comment,omitempty"`

	// Timestamp listing the creation time of the feedback submission.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// Information returned from the **Add Feedback** method.
	FeedbackData *FeedbackDataOutput `json:"feedback_data,omitempty"`
}

type GetBatchOptions struct {

	// The ID of the batch-processing job whose information you want to retrieve.
	BatchID *string `json:"batch_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type GetFeedback struct {

	// A string uniquely identifying the feedback entry.
	FeedbackID *string `json:"feedback_id,omitempty"`

	// A timestamp identifying the creation time of the feedback entry.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// A string containing the user's comment about the feedback entry.
	Comment *string `json:"comment,omitempty"`

	// Information returned from the **Add Feedback** method.
	FeedbackData *FeedbackDataOutput `json:"feedback_data,omitempty"`
}

type GetFeedbackOptions struct {

	// A string that specifies the feedback entry to be included in the output.
	FeedbackID *string `json:"feedback_id" validate:"required"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type HTMLReturn struct {

	// The number of pages in the input document.
	NumPages *string `json:"num_pages,omitempty"`

	// The author of the input document, if identified.
	Author *string `json:"author,omitempty"`

	// The publication date of the input document, if identified.
	PublicationDate *string `json:"publication_date,omitempty"`

	// The title of the input document, if identified.
	Title *string `json:"title,omitempty"`

	// The HTML version of the input document.
	HTML *string `json:"html,omitempty"`
}

type Interpretation struct {

	// The value that was located in the normalized text.
	Value *string `json:"value,omitempty"`

	// An integer or float expressing the numeric value of the `value` key.
	NumericValue *float64 `json:"numeric_value,omitempty"`

	// A string listing the unit of the value that was found in the normalized text.
	//
	// **Note:** The value of `unit` is the [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html)
	// identified for the currency amount (for example, `USD` or `EUR`). If the service cannot disambiguate a currency
	// symbol (for example, `$` or `£`), the value of `unit` contains the ambiguous symbol as-is.
	Unit *string `json:"unit,omitempty"`
}

type Key struct {

	// The unique ID of the key in the table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text content of the table cell without HTML markup.
	Text *string `json:"text,omitempty"`
}

type KeyValuePair struct {

	// A key in a key-value pair.
	Key *Key `json:"key,omitempty"`

	// A list of values in a key-value pair.
	Value []Value `json:"value,omitempty"`
}

type Label struct {

	// The identified `nature` of the element.
	Nature *string `json:"nature" validate:"required"`

	// The identified `party` of the element.
	Party *string `json:"party" validate:"required"`
}

type LeadingSentence struct {

	// The text of the leading sentence.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// An array of `location` objects that lists the locations of detected leading sentences.
	ElementLocations []ElementLocations `json:"element_locations,omitempty"`
}

type ListBatchesOptions struct {

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type ListFeedbackOptions struct {

	// An optional string that filters the output to include only feedback with the specified feedback type. The only
	// permitted value is `element_classification`.
	FeedbackType *string `json:"feedback_type,omitempty"`

	// An optional string in the format `YYYY-MM-DD` that filters the output to include only feedback that was added before
	// the specified date.
	Before *strfmt.Date `json:"before,omitempty"`

	// An optional string in the format `YYYY-MM-DD` that filters the output to include only feedback that was added after
	// the specified date.
	After *strfmt.Date `json:"after,omitempty"`

	// An optional string that filters the output to include only feedback from the document with the specified
	// `document_title`.
	DocumentTitle *string `json:"document_title,omitempty"`

	// An optional string that filters the output to include only feedback with the specified `model_id`. The only
	// permitted value is `contracts`.
	ModelID *string `json:"model_id,omitempty"`

	// An optional string that filters the output to include only feedback with the specified `model_version`.
	ModelVersion *string `json:"model_version,omitempty"`

	// An optional string in the form of a comma-separated list of categories. If it is specified, the service filters the
	// output to include only feedback that has at least one category from the list removed.
	CategoryRemoved *string `json:"category_removed,omitempty"`

	// An optional string in the form of a comma-separated list of categories. If this is specified, the service filters
	// the output to include only feedback that has at least one category from the list added.
	CategoryAdded *string `json:"category_added,omitempty"`

	// An optional string in the form of a comma-separated list of categories. If this is specified, the service filters
	// the output to include only feedback that has at least one category from the list unchanged.
	CategoryNotChanged *string `json:"category_not_changed,omitempty"`

	// An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output
	// to include only feedback that has at least one `nature`:`party` pair from the list removed.
	TypeRemoved *string `json:"type_removed,omitempty"`

	// An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output
	// to include only feedback that has at least one `nature`:`party` pair from the list removed.
	TypeAdded *string `json:"type_added,omitempty"`

	// An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output
	// to include only feedback that has at least one `nature`:`party` pair from the list unchanged.
	TypeNotChanged *string `json:"type_not_changed,omitempty"`

	// An optional integer specifying the number of documents that you want the service to return.
	PageLimit *int64 `json:"page_limit,omitempty"`

	// An optional string that returns the set of documents after the previous set. Use this parameter with the
	// `page_limit` parameter.
	Cursor *string `json:"cursor,omitempty"`

	// An optional comma-separated list of fields in the document to sort on. You can optionally specify the sort direction
	// by prefixing the value of the field with `-` for descending order or `+` for ascending order (the default).
	// Currently permitted sorting fields are `created`, `user_id`, and `document_title`.
	Sort *string `json:"sort,omitempty"`

	// An optional boolean value. If specified as `true`, the `pagination` object in the output includes a value called
	// `total` that gives the total count of feedback created.
	IncludeTotal *bool `json:"include_total,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type Location struct {

	// The element's `begin` index.
	Begin *int64 `json:"begin" validate:"required"`

	// The element's `end` index.
	End *int64 `json:"end" validate:"required"`
}

type Mention struct {

	// The name of the party.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type OriginalLabelsIn struct {

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabel `json:"types" validate:"required"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []Category `json:"categories" validate:"required"`
}

type OriginalLabelsOut struct {

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabel `json:"types,omitempty"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []Category `json:"categories,omitempty"`

	// A string identifying the type of modification the feedback entry in the `updated_labels` array. Possible values are
	// `added`, `not_changed`, and `removed`.
	Modification *string `json:"modification,omitempty"`
}

type Pagination struct {

	// A token identifying the current page of results.
	RefreshCursor *string `json:"refresh_cursor,omitempty"`

	// A token identifying the next page of results.
	NextCursor *string `json:"next_cursor,omitempty"`

	// The URL that returns the current page of results.
	RefreshURL *string `json:"refresh_url,omitempty"`

	// The URL that returns the next page of results.
	NextURL *string `json:"next_url,omitempty"`

	// Reserved for future use.
	Total *int64 `json:"total,omitempty"`
}

type Paragraphs struct {

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type Parties struct {

	// The normalized form of the party's name.
	Party *string `json:"party,omitempty"`

	// A string identifying the party's role.
	Role *string `json:"role,omitempty"`

	// A string that identifies the importance of the party.
	Importance *string `json:"importance,omitempty"`

	// A list of the party's address or addresses.
	Addresses []Address `json:"addresses,omitempty"`

	// A list of the names and roles of contacts identified in the input document.
	Contacts []Contact `json:"contacts,omitempty"`

	// A list of the party's mentions in the input document.
	Mentions []Mention `json:"mentions,omitempty"`
}

type PaymentTerms struct {

	// The confidence level in the identification of the payment term.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The payment term (duration).
	Text *string `json:"text,omitempty"`

	// The normalized form of the payment term, which is listed as a string. This element is optional; it is returned only
	// if normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text
	// exists.
	Interpretation *Interpretation `json:"interpretation,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type RowHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// If you provide customization input, the normalized version of the cell text according to the customization;
	// otherwise, the same value as `text`.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type SectionTitle struct {

	// The text of the section title, if identified.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type SectionTitles struct {

	// The text of the section title, if identified.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// An integer indicating the level at which the section is located in the input document. For example, `1` represents a
	// top-level section, `2` represents a subsection within the level `1` section, and so forth.
	Level *int64 `json:"level,omitempty"`

	// An array of `location` objects that lists the locations of detected section titles.
	ElementLocations []ElementLocations `json:"element_locations,omitempty"`
}

type ShortDoc struct {

	// The title of the input document, if identified.
	Title *string `json:"title,omitempty"`

	// The MD5 hash of the input document.
	Hash *string `json:"hash,omitempty"`
}

type TableHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The location of the table header cell in the current table as defined by its `begin` and `end` offsets,
	// respectfully, in the input document.
	Location interface{} `json:"location,omitempty"`

	// The textual contents of the cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type TableReturn struct {

	// Information about the parsed input document.
	Document *DocInfo `json:"document,omitempty"`

	// The ID of the model used to extract the table contents. The value for table extraction is `tables`.
	ModelID *string `json:"model_id,omitempty"`

	// The version of the `tables` model ID.
	ModelVersion *string `json:"model_version,omitempty"`

	// Definitions of the tables identified in the input document.
	Tables []Tables `json:"tables,omitempty"`
}

type TableTitle struct {

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text of the identified table title or caption.
	Text *string `json:"text,omitempty"`
}

type Tables struct {

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The textual contents of the current table from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// The table's section title, if identified.
	SectionTitle *SectionTitle `json:"section_title,omitempty"`

	// If identified, the title or caption of the current table of the form `Table x.: ...`. Empty when no title is
	// identified. When exposed, the `title` is also excluded from the `contexts` array of the same table.
	Title *TableTitle `json:"title,omitempty"`

	// An array of table-level cells that apply as headers to all the other cells in the current table.
	TableHeaders []TableHeaders `json:"table_headers,omitempty"`

	// An array of row-level cells, each applicable as a header to other cells in the same row as itself, of the current
	// table.
	RowHeaders []RowHeaders `json:"row_headers,omitempty"`

	// An array of column-level cells, each applicable as a header to other cells in the same column as itself, of the
	// current table.
	ColumnHeaders []ColumnHeaders `json:"column_headers,omitempty"`

	// An array of cells that are neither table header nor column header nor row header cells, of the current table with
	// corresponding row and column header associations.
	BodyCells []BodyCells `json:"body_cells,omitempty"`

	// An array of objects that list text that is related to the table contents and that precedes or follows the current
	// table.
	Contexts []Contexts `json:"contexts,omitempty"`

	// An array of key-value pairs identified in the current table.
	KeyValuePairs []KeyValuePair `json:"key_value_pairs,omitempty"`
}

type TerminationDates struct {

	// The confidence level in the identification of the termination date.
	ConfidenceLevel *string `json:"confidence_level,omitempty"`

	// The termination date.
	Text *string `json:"text,omitempty"`

	// The normalized form of the termination date, which is listed as a string. This element is optional; it is returned
	// only if normalized text exists.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`
}

type TypeLabel struct {

	// A pair of `nature` and `party` objects. The `nature` object identifies the effect of the element on the identified
	// `party`, and the `party` object identifies the affected party.
	Label *Label `json:"label,omitempty"`

	// Hashed values that you can send to IBM to provide feedback or receive support.
	ProvenanceIds []string `json:"provenance_ids,omitempty"`
}

type TypeLabelComparison struct {

	// A pair of `nature` and `party` objects. The `nature` object identifies the effect of the element on the identified
	// `party`, and the `party` object identifies the affected party.
	Label *Label `json:"label,omitempty"`
}

type UnalignedElement struct {

	// The label assigned to the document by the value of the `file_1_label` or `file_2_label` parameters on the **Compare
	// two documents** method.
	DocumentLabel *string `json:"document_label,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text of the element.
	Text *string `json:"text,omitempty"`

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabelComparison `json:"types,omitempty"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []CategoryComparison `json:"categories,omitempty"`

	// List of document attributes.
	Attributes []Attribute `json:"attributes,omitempty"`
}

type UpdateBatchOptions struct {

	// The ID of the batch-processing job you want to update.
	BatchID *string `json:"batch_id" validate:"required"`

	// The action you want to perform on the specified batch-processing job.
	Action *string `json:"action" validate:"required"`

	// The analysis model to be used by the service. For the **Element classification** and **Compare two documents**
	// methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults
	// apply to the standalone methods as well as to the methods' use in batch-processing requests.
	Model *string `json:"model,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type UpdatedLabelsIn struct {

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabel `json:"types" validate:"required"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []Category `json:"categories" validate:"required"`
}

type UpdatedLabelsOut struct {

	// Description of the action specified by the element and whom it affects.
	Types []TypeLabel `json:"types,omitempty"`

	// List of functional categories into which the element falls; in other words, the subject matter of the element.
	Categories []Category `json:"categories,omitempty"`

	// The type of modification the feedback entry in the `updated_labels` array. Possible values are `added`,
	// `not_changed`, and `removed`.
	Modification *string `json:"modification,omitempty"`
}

type Value struct {

	// The unique ID of the value in the table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *Location `json:"location,omitempty"`

	// The text content of the table cell without HTML markup.
	Text *string `json:"text,omitempty"`
}