You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: compare-comply/v1.ts
+55-69
Original file line number
Diff line number
Diff line change
@@ -430,8 +430,8 @@ class CompareComplyV1 extends BaseService {
430
430
* @param {string} [params.model_version] - An optional string that filters the output to include only feedback with
431
431
* the specified `model_version`.
432
432
* @param {string} [params.category_removed] - An optional string in the form of a comma-separated list of categories.
433
-
* If this is specified, the service filters the output to include only feedback that has at least one category from
434
-
* the list removed.
433
+
* If it is specified, the service filters the output to include only feedback that has at least one category from the
434
+
* list removed.
435
435
* @param {string} [params.category_added] - An optional string in the form of a comma-separated list of categories.
436
436
* If this is specified, the service filters the output to include only feedback that has at least one category from
437
437
* the list added.
@@ -1112,7 +1112,7 @@ namespace CompareComplyV1 {
1112
1112
model_id?: string;
1113
1113
/** An optional string that filters the output to include only feedback with the specified `model_version`. */
1114
1114
model_version?: string;
1115
-
/** 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 removed. */
1115
+
/** 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. */
1116
1116
category_removed?: string;
1117
1117
/** 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. */
1118
1118
category_added?: string;
@@ -1269,7 +1269,7 @@ namespace CompareComplyV1 {
1269
1269
element_pair?: ElementPair[];
1270
1270
/** 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. */
1271
1271
identical_text?: boolean;
1272
-
/** One or more hashed values that you can send to IBM to provide feedback or receive support. */
1272
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1273
1273
provenance_ids?: string[];
1274
1274
/** Indicates that the elements aligned are contractual clauses of significance. */
/** An array that contains the `id` value of a row header that is applicable to this body cell. */
1335
+
row_header_ids?: string[];
1336
+
/** An array that contains the `text` value of a row header that is applicable to this body cell. */
1337
+
row_header_texts?: string[];
1338
+
/** 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`. */
1339
+
row_header_texts_normalized?: string[];
1340
+
/** An array that contains the `id` value of a column header that is applicable to the current cell. */
1341
+
column_header_ids?: string[];
1342
+
/** An array that contains the `text` value of a column header that is applicable to the current cell. */
1343
+
column_header_texts?: string[];
1344
+
/** 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`. */
1345
+
column_header_texts_normalized?: string[];
1340
1346
attributes?: Attribute[];
1341
1347
}
1342
1348
1343
1349
/** Information defining an element's subject matter. */
1344
1350
exportinterfaceCategory{
1345
1351
/** The category of the associated element. */
1346
1352
label?: string;
1347
-
/** One or more hashed values that you can send to IBM to provide feedback or receive support. */
1353
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
/** An array of values, each being the `id` value of a column header that is applicable to the current cell. */
1388
-
exportinterfaceColumnHeaderIds{
1389
-
/** The `id` value of a column header. */
1390
-
id?: string;
1391
-
}
1392
-
1393
-
/** An array of values, each being the `text` value of a column header that is applicable to the current cell. */
1394
-
exportinterfaceColumnHeaderTexts{
1395
-
/** The `text` value of a column header. */
1396
-
text?: string;
1397
-
}
1398
-
1399
-
/** 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`. */
1400
-
exportinterfaceColumnHeaderTextsNormalized{
1401
-
/** The normalized version of a column header text. */
1402
-
text_normalized?: string;
1403
-
}
1404
-
1405
1395
/** Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table. */
1406
1396
exportinterfaceColumnHeaders{
1407
1397
/** The unique ID of the cell in the current table. */
/** The normalized form of the amount, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1451
+
/** The normalized form of the amount, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
1462
1452
text_normalized?: string;
1463
-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1453
+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
1464
1454
interpretation?: Interpretation;
1465
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1455
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1456
+
provenance_ids?: string[];
1457
+
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1458
+
location?: Location;
1459
+
}
1460
+
1461
+
/** The contract currencies that are declared in the document. */
1462
+
exportinterfaceContractCurrencies{
1463
+
/** The confidence level in the identification of the contract currency. */
1464
+
confidence_level?: string;
1465
+
/** The contract currency. */
1466
+
text?: string;
1467
+
/** 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. */
1468
+
text_normalized?: string;
1469
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1466
1470
provenance_ids?: string[];
1467
1471
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
/** The normalized form of the contract term, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1481
+
/** 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. */
1478
1482
text_normalized?: string;
1479
-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1483
+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
1480
1484
interpretation?: Interpretation;
1481
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1485
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1482
1486
provenance_ids?: string[];
1483
1487
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1484
1488
location?: Location;
@@ -1490,7 +1494,7 @@ namespace CompareComplyV1 {
1490
1494
confidence_level?: string;
1491
1495
/** The contract type. */
1492
1496
text?: string;
1493
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1497
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1494
1498
provenance_ids?: string[];
1495
1499
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1496
1500
location?: Location;
@@ -1546,9 +1550,9 @@ namespace CompareComplyV1 {
1546
1550
confidence_level?: string;
1547
1551
/** The effective date, listed as a string. */
1548
1552
text?: string;
1549
-
/** The normalized form of the effective date, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1553
+
/** 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. */
1550
1554
text_normalized?: string;
1551
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1555
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1552
1556
provenance_ids?: string[];
1553
1557
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1554
1558
location?: Location;
@@ -1688,7 +1692,7 @@ namespace CompareComplyV1 {
1688
1692
html?: string;
1689
1693
}
1690
1694
1691
-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1695
+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
1692
1696
exportinterfaceInterpretation{
1693
1697
/** The value that was located in the normalized text. */
1694
1698
value?: string;
@@ -1712,8 +1716,8 @@ namespace CompareComplyV1 {
1712
1716
exportinterfaceKeyValuePair{
1713
1717
/** A key in a key-value pair. */
1714
1718
key?: Key;
1715
-
/** A value in a key-value pair. */
1716
-
value?: Value;
1719
+
/** A list of values in a key-value pair. */
1720
+
value?: Value[];
1717
1721
}
1718
1722
1719
1723
/** 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. */
/** The normalized form of the payment term, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1817
+
/** 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. */
1814
1818
text_normalized?: string;
1815
-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1819
+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
1816
1820
interpretation?: Interpretation;
1817
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1821
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1818
1822
provenance_ids?: string[];
1819
1823
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1820
1824
location?: Location;
1821
1825
}
1822
1826
1823
-
/** An array of values, each being the `id` value of a row header that is applicable to this body cell. */
1824
-
exportinterfaceRowHeaderIds{
1825
-
/** The `id` values of a row header. */
1826
-
id?: string;
1827
-
}
1828
-
1829
-
/** An array of values, each being the `text` value of a row header that is applicable to this body cell. */
1830
-
exportinterfaceRowHeaderTexts{
1831
-
/** The `text` value of a row header. */
1832
-
text?: string;
1833
-
}
1834
-
1835
-
/** 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`. */
1836
-
exportinterfaceRowHeaderTextsNormalized{
1837
-
/** The normalized version of a row header text. */
1838
-
text_normalized?: string;
1839
-
}
1840
-
1841
1827
/** Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table. */
1842
1828
exportinterfaceRowHeaders{
1843
1829
/** The unique ID of the cell in the current table. */
@@ -1954,9 +1940,9 @@ namespace CompareComplyV1 {
1954
1940
confidence_level?: string;
1955
1941
/** The termination date. */
1956
1942
text?: string;
1957
-
/** The normalized form of the termination date, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1943
+
/** 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. */
1958
1944
text_normalized?: string;
1959
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1945
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1960
1946
provenance_ids?: string[];
1961
1947
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1962
1948
location?: Location;
@@ -1966,7 +1952,7 @@ namespace CompareComplyV1 {
1966
1952
exportinterfaceTypeLabel{
1967
1953
/** 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. */
1968
1954
label?: Label;
1969
-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1955
+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
0 commit comments