@anyformat/sdk 1.2.0 → 1.4.0

package/dist/index.d.cts

@@ -637,6 +637,50 @@ type ConfidenceCheck = {
      */
     type: 'confidence';
 };
+/**
+ * Consolidation
+ *
+ * Why a field of a long document has no value: its parts gave answers that could not be combined.
+ */
+type Consolidation = {
+    /**
+     * Candidates
+     *
+     * Each part's answer, to compare against the document before entering the value.
+     */
+    candidates: Array<ConsolidationCandidate>;
+    /**
+     * Status
+     *
+     * Always `unresolved`: no value could be chosen.
+     */
+    status: 'unresolved';
+};
+/**
+ * ConsolidationCandidate
+ *
+ * One part of a long document's answer for a field whose parts disagreed.
+ */
+type ConsolidationCandidate = {
+    /**
+     * Evidence
+     *
+     * Source-text snippets this part cited. Empty when it cited none.
+     */
+    evidence?: Array<Evidence>;
+    /**
+     * Value
+     *
+     * The value this part of the document gave.
+     */
+    value?: unknown | null;
+    /**
+     * Value Unit
+     *
+     * The unit of `value`, when it has one.
+     */
+    value_unit?: string | null;
+};
 /**
  * DatasetUploadFileV3
  *
@@ -1170,12 +1214,22 @@ type ExtractedField$1 = {
      * Model confidence in the extracted value, on a 0-100 scale. `null` when the backend did not produce a confidence (e.g. manual entry).
      */
     confidence?: number | null;
+    /**
+     * Set when a long document's parts gave answers that could not be combined; `value` is then `null`. Omitted otherwise.
+     */
+    consolidation?: Consolidation | null;
     /**
      * Evidence
      *
      * Source-text snippets the model used to derive this value.
      */
     evidence?: Array<Evidence>;
+    /**
+     * Lookup Check
+     *
+     * Whether the lookup `confirmed` the document value or was in `conflict` with it (the document value is kept). Omitted when no lookup compared the two.
+     */
+    lookup_check?: 'confirmed' | 'conflict' | null;
     /**
      * Value
      *
@@ -1188,6 +1242,12 @@ type ExtractedField$1 = {
      * A human-supplied override of the extracted `value`, if one was set during verification. `null` when no override exists.
      */
     value_override?: unknown | null;
+    /**
+     * Value Source
+     *
+     * Where a smart-lookup field's value came from. Omitted for other fields.
+     */
+    value_source?: 'document' | 'lookup' | null;
     /**
      * Verification Status
      *
@@ -1229,7 +1289,7 @@ type Extraction = {
     /**
      * Validations
      *
-     * Configured validation verdicts and automatic extraction review warnings. Unresolved chunk fields have a null value and an inconclusive warning with candidate values and evidence, even without a validate node.
+     * Verdicts of the workflow's validate nodes.
      */
     validations?: Array<Validation>;
 };
@@ -2151,7 +2211,7 @@ type StringField = {
 /**
  * Validation
  *
- * A configured rule verdict or an automatic extraction review warning.
+ * A configured rule verdict.
  */
 type Validation = {
     /**
@@ -2177,7 +2237,7 @@ type Validation = {
     /**
      * Rule Id
      *
-     * The configured rule ID, or an `extract.consolidation:` ID for an automatic review warning.
+     * The configured rule ID.
      */
     rule_id: string;
     /**

package/dist/index.d.ts

@@ -637,6 +637,50 @@ type ConfidenceCheck = {
      */
     type: 'confidence';
 };
+/**
+ * Consolidation
+ *
+ * Why a field of a long document has no value: its parts gave answers that could not be combined.
+ */
+type Consolidation = {
+    /**
+     * Candidates
+     *
+     * Each part's answer, to compare against the document before entering the value.
+     */
+    candidates: Array<ConsolidationCandidate>;
+    /**
+     * Status
+     *
+     * Always `unresolved`: no value could be chosen.
+     */
+    status: 'unresolved';
+};
+/**
+ * ConsolidationCandidate
+ *
+ * One part of a long document's answer for a field whose parts disagreed.
+ */
+type ConsolidationCandidate = {
+    /**
+     * Evidence
+     *
+     * Source-text snippets this part cited. Empty when it cited none.
+     */
+    evidence?: Array<Evidence>;
+    /**
+     * Value
+     *
+     * The value this part of the document gave.
+     */
+    value?: unknown | null;
+    /**
+     * Value Unit
+     *
+     * The unit of `value`, when it has one.
+     */
+    value_unit?: string | null;
+};
 /**
  * DatasetUploadFileV3
  *
@@ -1170,12 +1214,22 @@ type ExtractedField$1 = {
      * Model confidence in the extracted value, on a 0-100 scale. `null` when the backend did not produce a confidence (e.g. manual entry).
      */
     confidence?: number | null;
+    /**
+     * Set when a long document's parts gave answers that could not be combined; `value` is then `null`. Omitted otherwise.
+     */
+    consolidation?: Consolidation | null;
     /**
      * Evidence
      *
      * Source-text snippets the model used to derive this value.
      */
     evidence?: Array<Evidence>;
+    /**
+     * Lookup Check
+     *
+     * Whether the lookup `confirmed` the document value or was in `conflict` with it (the document value is kept). Omitted when no lookup compared the two.
+     */
+    lookup_check?: 'confirmed' | 'conflict' | null;
     /**
      * Value
      *
@@ -1188,6 +1242,12 @@ type ExtractedField$1 = {
      * A human-supplied override of the extracted `value`, if one was set during verification. `null` when no override exists.
      */
     value_override?: unknown | null;
+    /**
+     * Value Source
+     *
+     * Where a smart-lookup field's value came from. Omitted for other fields.
+     */
+    value_source?: 'document' | 'lookup' | null;
     /**
      * Verification Status
      *
@@ -1229,7 +1289,7 @@ type Extraction = {
     /**
      * Validations
      *
-     * Configured validation verdicts and automatic extraction review warnings. Unresolved chunk fields have a null value and an inconclusive warning with candidate values and evidence, even without a validate node.
+     * Verdicts of the workflow's validate nodes.
      */
     validations?: Array<Validation>;
 };
@@ -2151,7 +2211,7 @@ type StringField = {
 /**
  * Validation
  *
- * A configured rule verdict or an automatic extraction review warning.
+ * A configured rule verdict.
  */
 type Validation = {
     /**
@@ -2177,7 +2237,7 @@ type Validation = {
     /**
      * Rule Id
      *
-     * The configured rule ID, or an `extract.consolidation:` ID for an automatic review warning.
+     * The configured rule ID.
      */
     rule_id: string;
     /**

package/dist/index.js

@@ -1,7 +1,7 @@
 // package.json
 var package_default = {
   name: "@anyformat/sdk",
-  version: "1.2.0",
+  version: "1.4.0",
   description: "TypeScript SDK for the AnyFormat API",
   license: "MIT",
   author: "Anyformat <info@anyformat.ai>",