unstructured-transform-client 0.18.103 → 0.18.105

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/ElementMetadata.d.ts

@@ -20,11 +20,9 @@ export interface ElementMetadata {
      */
     pageNumber: number | null;
     /**
-     * Coordinate projection when requested.
+     * One box for an element on one page, or an array with one box and its page_number per page for an element that spans pages.
      */
-    coordinates: {
-        [key: string]: any;
-    } | null;
+    coordinates: any | null;
     /**
      * Table HTML projection when requested.
      */

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/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
@@ -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.
      */

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
  */
@@ -73,6 +75,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 +97,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/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.103";
+export declare const VERSION = "0.18.105";

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.103";
+export const VERSION = "0.18.105";

package/package.json

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