unstructured-transform-client 0.18.18

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

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+import type { ErrorCode } from './ErrorCode.js';
+/**
+ * A machine-readable code and an actionable message.
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     *
+     */
+    code: ErrorCode;
+    /**
+     * What went wrong, and what to do about it.
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+export declare function instanceOfModelError(value: object): value is ModelError;
+export declare function ModelErrorFromJSON(json: any): ModelError;
+export declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError;
+export declare function ModelErrorToJSON(json: any): ModelError;
+export declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/ModelError.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+import { ErrorCodeFromJSON, ErrorCodeToJSON, } from './ErrorCode.js';
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+export function instanceOfModelError(value) {
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function ModelErrorFromJSON(json) {
+    return ModelErrorFromJSONTyped(json, false);
+}
+export function ModelErrorFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': ErrorCodeFromJSON(json['code']),
+        'message': json['message'],
+    };
+}
+export function ModelErrorToJSON(json) {
+    return ModelErrorToJSONTyped(json, false);
+}
+export function ModelErrorToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': ErrorCodeToJSON(value['code']),
+        'message': value['message'],
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * Shape of the parsed output.
+ * @export
+ */
+export declare const OutputFormat: {
+    readonly Markdown: "markdown";
+    readonly Elements: "elements";
+};
+export type OutputFormat = typeof OutputFormat[keyof typeof OutputFormat];
+export declare function instanceOfOutputFormat(value: any): boolean;
+export declare function OutputFormatFromJSON(json: any): OutputFormat;
+export declare function OutputFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutputFormat;
+export declare function OutputFormatToJSON(value?: OutputFormat | null): any;
+export declare function OutputFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): OutputFormat;

package/dist/_generated/models/OutputFormat.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Shape of the parsed output.
+ * @export
+ */
+export const OutputFormat = {
+    Markdown: 'markdown',
+    Elements: 'elements',
+};
+export function instanceOfOutputFormat(value) {
+    for (const key in OutputFormat) {
+        if (Object.prototype.hasOwnProperty.call(OutputFormat, key)) {
+            if (OutputFormat[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function OutputFormatFromJSON(json) {
+    return OutputFormatFromJSONTyped(json, false);
+}
+export function OutputFormatFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function OutputFormatToJSON(value) {
+    return value;
+}
+export function OutputFormatToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,87 @@
+/**
+ * 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.
+ */
+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';
+/**
+ * Parse operation metadata plus the canonical document, possibly before extraction has finished.
+ * @export
+ * @interface ParseResult
+ */
+export interface ParseResult {
+    /**
+     * Underlying job id, for support and tracing.
+     */
+    id: string;
+    /**
+     *
+     */
+    status: TransformStatus;
+    /**
+     * The effective profile used for raw-document partitioning.
+     */
+    profile: ParseResultProfileEnum | null;
+    /**
+     * Rendered Markdown projection when requested; null when elements are requested.
+     */
+    markdown: string | null;
+    /**
+     * The document envelope version.
+     */
+    formatVersion: ParseResultFormatVersionEnum;
+    /**
+     *
+     */
+    metadata: DocumentMetadata;
+    /**
+     * Completed extraction results are available only after extraction has finished.
+     */
+    extractedData: Array<ExtractionResult> | null;
+    /**
+     * Notes about a result that still succeeded.
+     */
+    warnings?: Array<TransformWarning>;
+    /**
+     * Public document elements.
+     */
+    elements: Array<Element>;
+    /**
+     * The associated original uploaded source file, when known.
+     */
+    source: SourceFile | null;
+}
+/**
+ * @export
+ */
+export declare const ParseResultProfileEnum: {
+    readonly Balanced: "balanced";
+    readonly Best: "best";
+};
+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.
+ */
+export declare function instanceOfParseResult(value: object): value is ParseResult;
+export declare function ParseResultFromJSON(json: any): ParseResult;
+export declare function ParseResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ParseResult;
+export declare function ParseResultToJSON(json: any): ParseResult;
+export declare function ParseResultToJSONTyped(value?: ParseResult | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/ParseResult.js

@@ -0,0 +1,98 @@
+/* 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.
+ */
+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';
+/**
+ * @export
+ */
+export const ParseResultProfileEnum = {
+    Balanced: 'balanced',
+    Best: 'best',
+};
+/**
+ * @export
+ */
+export const ParseResultFormatVersionEnum = {
+    _20: '2.0',
+};
+/**
+ * Check if a given object implements the ParseResult interface.
+ */
+export function instanceOfParseResult(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('profile' in value) || value['profile'] === undefined)
+        return false;
+    if (!('markdown' in value) || value['markdown'] === undefined)
+        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))
+        return false;
+    if (!('elements' in value) || value['elements'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    return true;
+}
+export function ParseResultFromJSON(json) {
+    return ParseResultFromJSONTyped(json, false);
+}
+export function ParseResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': TransformStatusFromJSON(json['status']),
+        'profile': json['profile'],
+        'markdown': json['markdown'],
+        'formatVersion': json['format_version'],
+        'metadata': DocumentMetadataFromJSON(json['metadata']),
+        'extractedData': (json['extracted_data'] == null ? null : json['extracted_data'].map(ExtractionResultFromJSON)),
+        'warnings': json['warnings'] == null ? undefined : (json['warnings'].map(TransformWarningFromJSON)),
+        'elements': (json['elements'].map(ElementFromJSON)),
+        'source': SourceFileFromJSON(json['source']),
+    };
+}
+export function ParseResultToJSON(json) {
+    return ParseResultToJSONTyped(json, false);
+}
+export function ParseResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': TransformStatusToJSON(value['status']),
+        'profile': value['profile'],
+        'markdown': value['markdown'],
+        'format_version': value['formatVersion'],
+        'metadata': DocumentMetadataToJSON(value['metadata']),
+        'extracted_data': (value['extractedData'] == null ? null : value['extractedData'].map(ExtractionResultToJSON)),
+        'warnings': value['warnings'] == null ? undefined : (value['warnings'].map(TransformWarningToJSON)),
+        'elements': (value['elements'].map(ElementToJSON)),
+        'source': SourceFileToJSON(value['source']),
+    };
+}

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

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+/**
+ * A source file retained in the same 24-hour scratch storage used by explicit uploads. Polling jobs or downloading results does not extend this expiry. Callers may retrieve it with GET /api/v2/upload/{file_id} while it exists, and may delete it with DELETE /api/v2/upload/{file_id} without deleting the job or its result.
+ * @export
+ * @interface SourceFile
+ */
+export interface SourceFile {
+    /**
+     * The ID of the uploaded source file.
+     */
+    fileId: string | null;
+    /**
+     * The filename supplied with the source document, when available.
+     */
+    filename: string | null;
+    /**
+     * The detected MIME type of the source file.
+     */
+    mimetype: string | null;
+    /**
+     * When the source file will be automatically deleted.
+     */
+    expiresAt: Date | null;
+}
+/**
+ * Check if a given object implements the SourceFile interface.
+ */
+export declare function instanceOfSourceFile(value: object): value is SourceFile;
+export declare function SourceFileFromJSON(json: any): SourceFile;
+export declare function SourceFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceFile;
+export declare function SourceFileToJSON(json: any): SourceFile;
+export declare function SourceFileToJSONTyped(value?: SourceFile | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/SourceFile.js

@@ -0,0 +1,56 @@
+/* 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.
+ */
+import { parseDateTime, serializeDateTime } from '../runtime.js';
+/**
+ * Check if a given object implements the SourceFile interface.
+ */
+export function instanceOfSourceFile(value) {
+    if ((!('fileId' in value) && !('file_id' in value)) || (value['fileId'] === undefined && value['file_id'] === undefined))
+        return false;
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('mimetype' in value) || value['mimetype'] === undefined)
+        return false;
+    if ((!('expiresAt' in value) && !('expires_at' in value)) || (value['expiresAt'] === undefined && value['expires_at'] === undefined))
+        return false;
+    return true;
+}
+export function SourceFileFromJSON(json) {
+    return SourceFileFromJSONTyped(json, false);
+}
+export function SourceFileFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['file_id'],
+        'filename': json['filename'],
+        'mimetype': json['mimetype'],
+        'expiresAt': (json['expires_at'] == null ? null : parseDateTime(json['expires_at'])),
+    };
+}
+export function SourceFileToJSON(json) {
+    return SourceFileToJSONTyped(json, false);
+}
+export function SourceFileToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file_id': value['fileId'],
+        'filename': value['filename'],
+        'mimetype': value['mimetype'],
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : serializeDateTime(value['expiresAt']),
+    };
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Document processing or terminal status.
+ * @export
+ */
+export declare const TransformStatus: {
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly CompletedWithWarnings: "completed_with_warnings";
+};
+export type TransformStatus = typeof TransformStatus[keyof typeof TransformStatus];
+export declare function instanceOfTransformStatus(value: any): boolean;
+export declare function TransformStatusFromJSON(json: any): TransformStatus;
+export declare function TransformStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransformStatus;
+export declare function TransformStatusToJSON(value?: TransformStatus | null): any;
+export declare function TransformStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): TransformStatus;

package/dist/_generated/models/TransformStatus.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ * Document processing or terminal status.
+ * @export
+ */
+export const TransformStatus = {
+    Processing: 'processing',
+    Completed: 'completed',
+    CompletedWithWarnings: 'completed_with_warnings',
+};
+export function instanceOfTransformStatus(value) {
+    for (const key in TransformStatus) {
+        if (Object.prototype.hasOwnProperty.call(TransformStatus, key)) {
+            if (TransformStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function TransformStatusFromJSON(json) {
+    return TransformStatusFromJSONTyped(json, false);
+}
+export function TransformStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function TransformStatusToJSON(value) {
+    return value;
+}
+export function TransformStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,34 @@
+/**
+ * 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 TransformWarning
+ */
+export interface TransformWarning {
+    /**
+     * Stable identifier, safe to branch on.
+     */
+    code: string;
+    /**
+     * Human-readable detail.
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the TransformWarning interface.
+ */
+export declare function instanceOfTransformWarning(value: object): value is TransformWarning;
+export declare function TransformWarningFromJSON(json: any): TransformWarning;
+export declare function TransformWarningFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransformWarning;
+export declare function TransformWarningToJSON(json: any): TransformWarning;
+export declare function TransformWarningToJSONTyped(value?: TransformWarning | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/TransformWarning.js

@@ -0,0 +1,47 @@
+/* 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 TransformWarning interface.
+ */
+export function instanceOfTransformWarning(value) {
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function TransformWarningFromJSON(json) {
+    return TransformWarningFromJSONTyped(json, false);
+}
+export function TransformWarningFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': json['code'],
+        'message': json['message'],
+    };
+}
+export function TransformWarningToJSON(json) {
+    return TransformWarningToJSONTyped(json, false);
+}
+export function TransformWarningToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': value['code'],
+        'message': value['message'],
+    };
+}

package/dist/_generated/models/UploadResult.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.
+ */
+/**
+ * The result of uploading a file.
+ * @export
+ * @interface UploadResult
+ */
+export interface UploadResult {
+    /**
+     * The ID of the uploaded file.
+     */
+    fileId: string;
+    /**
+     * The detected MIME type of the file.
+     */
+    mimetype: string;
+    /**
+     * When the file will be automatically deleted.
+     */
+    expiresAt: Date;
+}
+/**
+ * Check if a given object implements the UploadResult interface.
+ */
+export declare function instanceOfUploadResult(value: object): value is UploadResult;
+export declare function UploadResultFromJSON(json: any): UploadResult;
+export declare function UploadResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadResult;
+export declare function UploadResultToJSON(json: any): UploadResult;
+export declare function UploadResultToJSONTyped(value?: UploadResult | null, ignoreDiscriminator?: boolean): any;