unstructured-transform-client 0.18.104 → 0.18.106

package/dist/_generated/apis/ParseApi.d.ts

@@ -53,6 +53,10 @@ export interface ParseRunRequest {
      * Optional JSON object of advanced options. The only supported option is enrichments.image_description, a boolean that defaults to false.
      */
     advancedOptions?: string;
+    /**
+     * Enable field-level Extract confidence when schema is supplied.
+     */
+    extractConfidence?: boolean;
 }
 /**
  *

package/dist/_generated/apis/ParseApi.js

@@ -78,6 +78,9 @@ export class ParseApi extends runtime.BaseAPI {
         if (requestParameters['advancedOptions'] != null) {
             formParams.append('advanced_options', requestParameters['advancedOptions']);
         }
+        if (requestParameters['extractConfidence'] != null) {
+            formParams.append('extract_confidence', requestParameters['extractConfidence']);
+        }
         let urlPath = `/api/v2/parse`;
         return {
             path: urlPath,

package/dist/_generated/models/AdvancedOptions.d.ts

@@ -20,6 +20,10 @@ export interface AdvancedOptions {
      *
      */
     enrichments: Enrichments;
+    /**
+     * Whether field-level Extract confidence was enabled for the job.
+     */
+    extractConfidence?: boolean;
 }
 /**
  * Check if a given object implements the AdvancedOptions interface.

package/dist/_generated/models/AdvancedOptions.js

@@ -29,6 +29,7 @@ export function AdvancedOptionsFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'enrichments': EnrichmentsFromJSON(json['enrichments']),
+        'extractConfidence': json['extract_confidence'] == null ? undefined : json['extract_confidence'],
     };
 }
 export function AdvancedOptionsToJSON(json) {
@@ -40,5 +41,6 @@ export function AdvancedOptionsToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'enrichments': EnrichmentsToJSON(value['enrichments']),
+        'extract_confidence': value['extractConfidence'],
     };
 }

package/dist/_generated/models/DegradedPage.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DegradedPage
+ */
+export interface DegradedPage {
+    /**
+     * The 1-based page number.
+     */
+    page: number;
+    /**
+     * Detected regions on the page whose content could not be recognized.
+     */
+    failedRegions: number;
+    /**
+     * Detected regions on the page.
+     */
+    totalRegions: number;
+}
+/**
+ * Check if a given object implements the DegradedPage interface.
+ */
+export declare function instanceOfDegradedPage(value: object): value is DegradedPage;
+export declare function DegradedPageFromJSON(json: any): DegradedPage;
+export declare function DegradedPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): DegradedPage;
+export declare function DegradedPageToJSON(json: any): DegradedPage;
+export declare function DegradedPageToJSONTyped(value?: DegradedPage | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/DegradedPage.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the DegradedPage interface.
+ */
+export function instanceOfDegradedPage(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if ((!('failedRegions' in value) && !('failed_regions' in value)) || (value['failedRegions'] === undefined && value['failed_regions'] === undefined))
+        return false;
+    if ((!('totalRegions' in value) && !('total_regions' in value)) || (value['totalRegions'] === undefined && value['total_regions'] === undefined))
+        return false;
+    return true;
+}
+export function DegradedPageFromJSON(json) {
+    return DegradedPageFromJSONTyped(json, false);
+}
+export function DegradedPageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'failedRegions': json['failed_regions'],
+        'totalRegions': json['total_regions'],
+    };
+}
+export function DegradedPageToJSON(json) {
+    return DegradedPageToJSONTyped(json, false);
+}
+export function DegradedPageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'failed_regions': value['failedRegions'],
+        'total_regions': value['totalRegions'],
+    };
+}

package/dist/_generated/models/ExtractRequest.d.ts

@@ -29,6 +29,10 @@ export interface ExtractRequest {
      * Optional free-text guidance that shapes how extracted fields are filled. Limited to 1,048,576 bytes when encoded as UTF-8.
      */
     prompt?: string;
+    /**
+     * Enable field-level Extract confidence for this request.
+     */
+    extractConfidence?: boolean;
 }
 /**
  * Check if a given object implements the ExtractRequest interface.

package/dist/_generated/models/ExtractRequest.js

@@ -32,6 +32,7 @@ export function ExtractRequestFromJSONTyped(json, ignoreDiscriminator) {
         'parseId': json['parse_id'],
         'schema': json['schema'],
         'prompt': json['prompt'] == null ? undefined : json['prompt'],
+        'extractConfidence': json['extract_confidence'] == null ? undefined : json['extract_confidence'],
     };
 }
 export function ExtractRequestToJSON(json) {
@@ -45,5 +46,6 @@ export function ExtractRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'parse_id': value['parseId'],
         'schema': value['schema'],
         'prompt': value['prompt'],
+        'extract_confidence': value['extractConfidence'],
     };
 }

package/dist/_generated/models/ExtractionResult.d.ts

@@ -17,7 +17,7 @@ import type { FieldMetadata } from './FieldMetadata.js';
  */
 export interface ExtractionResult {
     /**
-     * Extracted value conforming to the caller's schema.
+     * Natural schema-shaped data in version 2.0; version 2.1 recursively wraps each present object property as value and extract_confidence.
      */
     data: any | null;
     /**

package/dist/_generated/models/FailedPage.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FailedPage
+ */
+export interface FailedPage {
+    /**
+     * The 1-based page number.
+     */
+    page: number;
+    /**
+     * Stable identifier, safe to branch on.
+     */
+    code: string;
+    /**
+     * Human-readable reason.
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the FailedPage interface.
+ */
+export declare function instanceOfFailedPage(value: object): value is FailedPage;
+export declare function FailedPageFromJSON(json: any): FailedPage;
+export declare function FailedPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): FailedPage;
+export declare function FailedPageToJSON(json: any): FailedPage;
+export declare function FailedPageToJSONTyped(value?: FailedPage | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/FailedPage.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the FailedPage interface.
+ */
+export function instanceOfFailedPage(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function FailedPageFromJSON(json) {
+    return FailedPageFromJSONTyped(json, false);
+}
+export function FailedPageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'code': json['code'],
+        'message': json['message'],
+    };
+}
+export function FailedPageToJSON(json) {
+    return FailedPageToJSONTyped(json, false);
+}
+export function FailedPageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'code': value['code'],
+        'message': value['message'],
+    };
+}

package/dist/_generated/models/JobConfiguration.d.ts

@@ -11,7 +11,7 @@
  */
 import type { AdvancedOptions } from './AdvancedOptions.js';
 /**
- * The saved settings of one Parse job.
+ * The saved settings of one Parse or Extract job.
  * @export
  * @interface JobConfiguration
  */

package/dist/_generated/models/JobResult.d.ts

@@ -49,7 +49,7 @@ export interface JobResult {
      */
     error?: Error;
     /**
-     * The settings this job ran with, available in every status. Null for extraction jobs, which run no partitioner of their own.
+     * The settings this job ran with, available in every status. Null for Extract jobs that ran without field confidence, because they run no partitioner of their own. When field confidence was requested, this contains the saved Extract settings.
      */
     configuration?: JobConfiguration | null;
     /**

package/dist/_generated/models/ParseResult.d.ts

@@ -9,12 +9,14 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { FailedPage } from './FailedPage.js';
 import type { TransformWarning } from './TransformWarning.js';
 import type { DocumentMetadata } from './DocumentMetadata.js';
 import type { TransformStatus } from './TransformStatus.js';
 import type { Element } from './Element.js';
 import type { ExtractionResult } from './ExtractionResult.js';
 import type { SourceFile } from './SourceFile.js';
+import type { DegradedPage } from './DegradedPage.js';
 /**
  * Parse operation metadata plus the canonical document, possibly before extraction has finished.
  * @export
@@ -38,9 +40,9 @@ export interface ParseResult {
      */
     markdown: string | null;
     /**
-     * The document envelope version.
+     * The document envelope version. Version 2.1 is returned only when extract_confidence was enabled and uses value/confidence wrappers.
      */
-    formatVersion: ParseResultFormatVersionEnum;
+    formatVersion: string;
     /**
      *
      */
@@ -53,6 +55,14 @@ export interface ParseResult {
      * Notes about a result that still succeeded.
      */
     warnings?: Array<TransformWarning>;
+    /**
+     * Pages that could not be processed and have no elements in this result.
+     */
+    failedPages?: Array<FailedPage>;
+    /**
+     * Pages that are in this result although some of their content could not be recognized.
+     */
+    degradedPages?: Array<DegradedPage>;
     /**
      * Public document elements.
      */
@@ -71,13 +81,6 @@ export declare const ParseResultProfileEnum: {
     readonly Test: "test";
 };
 export type ParseResultProfileEnum = typeof ParseResultProfileEnum[keyof typeof ParseResultProfileEnum];
-/**
- * @export
- */
-export declare const ParseResultFormatVersionEnum: {
-    readonly _20: "2.0";
-};
-export type ParseResultFormatVersionEnum = typeof ParseResultFormatVersionEnum[keyof typeof ParseResultFormatVersionEnum];
 /**
  * Check if a given object implements the ParseResult interface.
  */

package/dist/_generated/models/ParseResult.js

@@ -11,12 +11,14 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { FailedPageFromJSON, FailedPageToJSON, } from './FailedPage.js';
 import { TransformWarningFromJSON, TransformWarningToJSON, } from './TransformWarning.js';
 import { DocumentMetadataFromJSON, DocumentMetadataToJSON, } from './DocumentMetadata.js';
 import { TransformStatusFromJSON, TransformStatusToJSON, } from './TransformStatus.js';
 import { ElementFromJSON, ElementToJSON, } from './Element.js';
 import { ExtractionResultFromJSON, ExtractionResultToJSON, } from './ExtractionResult.js';
 import { SourceFileFromJSON, SourceFileToJSON, } from './SourceFile.js';
+import { DegradedPageFromJSON, DegradedPageToJSON, } from './DegradedPage.js';
 /**
  * @export
  */
@@ -25,12 +27,6 @@ export const ParseResultProfileEnum = {
     Best: 'best',
     Test: 'test',
 };
-/**
- * @export
- */
-export const ParseResultFormatVersionEnum = {
-    _20: '2.0',
-};
 /**
  * Check if a given object implements the ParseResult interface.
  */
@@ -45,8 +41,6 @@ export function instanceOfParseResult(value) {
         return false;
     if ((!('formatVersion' in value) && !('format_version' in value)) || (value['formatVersion'] === undefined && value['format_version'] === undefined))
         return false;
-    if (value['formatVersion'] !== '2.0' && value['format_version'] !== '2.0')
-        return false;
     if (!('metadata' in value) || value['metadata'] === undefined)
         return false;
     if ((!('extractedData' in value) && !('extracted_data' in value)) || (value['extractedData'] === undefined && value['extracted_data'] === undefined))
@@ -73,6 +67,8 @@ export function ParseResultFromJSONTyped(json, ignoreDiscriminator) {
         'metadata': DocumentMetadataFromJSON(json['metadata']),
         'extractedData': (json['extracted_data'] == null ? null : json['extracted_data'].map(ExtractionResultFromJSON)),
         'warnings': json['warnings'] == null ? undefined : (json['warnings'].map(TransformWarningFromJSON)),
+        'failedPages': json['failed_pages'] == null ? undefined : (json['failed_pages'].map(FailedPageFromJSON)),
+        'degradedPages': json['degraded_pages'] == null ? undefined : (json['degraded_pages'].map(DegradedPageFromJSON)),
         'elements': (json['elements'].map(ElementFromJSON)),
         'source': SourceFileFromJSON(json['source']),
     };
@@ -93,6 +89,8 @@ export function ParseResultToJSONTyped(value, ignoreDiscriminator = false) {
         'metadata': DocumentMetadataToJSON(value['metadata']),
         'extracted_data': (value['extractedData'] == null ? null : value['extractedData'].map(ExtractionResultToJSON)),
         'warnings': value['warnings'] == null ? undefined : (value['warnings'].map(TransformWarningToJSON)),
+        'failed_pages': value['failedPages'] == null ? undefined : (value['failedPages'].map(FailedPageToJSON)),
+        'degraded_pages': value['degradedPages'] == null ? undefined : (value['degradedPages'].map(DegradedPageToJSON)),
         'elements': (value['elements'].map(ElementToJSON)),
         'source': SourceFileToJSON(value['source']),
     };

package/dist/_generated/models/index.d.ts

@@ -1,5 +1,6 @@
 export * from './AdvancedOptions.js';
 export * from './Citation.js';
+export * from './DegradedPage.js';
 export * from './DocumentMetadata.js';
 export * from './Element.js';
 export * from './ElementMetadata.js';
@@ -7,6 +8,7 @@ export * from './Enrichments.js';
 export * from './ErrorCode.js';
 export * from './ExtractRequest.js';
 export * from './ExtractionResult.js';
+export * from './FailedPage.js';
 export * from './FieldMetadata.js';
 export * from './JobAccepted.js';
 export * from './JobConfiguration.js';

package/dist/_generated/models/index.js

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './AdvancedOptions.js';
 export * from './Citation.js';
+export * from './DegradedPage.js';
 export * from './DocumentMetadata.js';
 export * from './Element.js';
 export * from './ElementMetadata.js';
@@ -9,6 +10,7 @@ export * from './Enrichments.js';
 export * from './ErrorCode.js';
 export * from './ExtractRequest.js';
 export * from './ExtractionResult.js';
+export * from './FailedPage.js';
 export * from './FieldMetadata.js';
 export * from './JobAccepted.js';
 export * from './JobConfiguration.js';

package/dist/client.d.ts

@@ -79,6 +79,8 @@ export interface ParseOptions extends RequestOptions {
     profile?: ParseRunProfileEnum;
     /** `{ enrichments: { imageDescription: true } }` describes the images in the document. */
     advancedOptions?: AdvancedOptions;
+    /** Return field-level Extract confidence with the 2.1 response shape. */
+    extractConfidence?: boolean;
     waitSeconds?: number;
 }
 declare class ParseNamespace {
@@ -97,6 +99,7 @@ export interface ExtractOptions extends RequestOptions {
     parseId: string;
     schema: Record<string, unknown>;
     prompt?: string;
+    extractConfidence?: boolean;
     waitSeconds?: number;
 }
 export interface ExtractFromDocumentOptions extends RequestOptions {
@@ -107,6 +110,7 @@ export interface ExtractFromDocumentOptions extends RequestOptions {
     schema: Record<string, unknown>;
     prompt?: string;
     profile?: ParseRunProfileEnum;
+    extractConfidence?: boolean;
     waitSeconds?: number;
 }
 declare class ExtractNamespace {

package/dist/client.js

@@ -163,6 +163,7 @@ class ParseNamespace {
             prompt: options.prompt,
             profile: options.profile,
             advancedOptions: advancedOptionsToWire(options.advancedOptions),
+            ...(options.extractConfidence ? { extractConfidence: true } : {}),
         }, requestInit(options)));
     }
 }
@@ -178,6 +179,7 @@ class ExtractNamespace {
                 parseId: options.parseId,
                 schema: options.schema,
                 prompt: options.prompt,
+                ...(options.extractConfidence ? { extractConfidence: true } : {}),
             },
             prefer: prefer(options.waitSeconds),
         }, requestInit(options)));
@@ -210,6 +212,7 @@ class ExtractNamespace {
                 schema: JSON.stringify(options.schema),
                 prompt: options.prompt,
                 profile: options.profile,
+                extract_confidence: options.extractConfidence ? "true" : undefined,
             },
             waitSeconds: options.waitSeconds,
             signal: options.signal,

package/dist/version.d.ts

@@ -12,4 +12,4 @@
  * (tools/release/derived_versions.py); change the series only for a
  * deliberate minor or major release.
  */
-export declare const VERSION = "0.18.104";
+export declare const VERSION = "0.18.106";

package/dist/version.js

@@ -12,4 +12,4 @@
  * (tools/release/derived_versions.py); change the series only for a
  * deliberate minor or major release.
  */
-export const VERSION = "0.18.104";
+export const VERSION = "0.18.106";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unstructured-transform-client",
-  "version": "0.18.104",
+  "version": "0.18.106",
   "description": "TypeScript client for the Unstructured Transform v2 API — one document in, structured output back.",
   "license": "MIT",
   "author": "Unstructured",