extend-ai 0.0.1-beta

package/api/types/ParseResponseStatus.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the parser run:
+ * * `"PROCESSED"` - The file was successfully processed
+ * * `"FAILED"` - The processing failed (see failureReason for details)
+ */
+export type ParseResponseStatus = "PROCESSED" | "FAILED";
+export declare const ParseResponseStatus: {
+    readonly Processed: "PROCESSED";
+    readonly Failed: "FAILED";
+};

package/api/types/ParseResponseStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseResponseStatus = void 0;
+exports.ParseResponseStatus = {
+    Processed: "PROCESSED",
+    Failed: "FAILED",
+};

package/api/types/Polygon.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Polygon {
+    /** X coordinate of the point */
+    x: number;
+    /** Y coordinate of the point */
+    y: number;
+}

package/api/types/Polygon.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Processor.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface Processor {
+    /** The type of response. In this case, it will always be `"document_processor"`. */
+    object: string;
+    /**
+     * The ID of the processor.
+     *
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    id: string;
+    /**
+     * The name of the processor.
+     *
+     * Example: `"Invoice Processor"`
+     */
+    name: string;
+    type: Extend.ProcessorType;
+    /**
+     * The time (in UTC) at which the processor was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    createdAt: string;
+    /**
+     * The time (in UTC) at which the processor was last updated. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    updatedAt: string;
+    draftVersion: Extend.ProcessorVersion;
+}

package/api/types/Processor.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorId.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The ID of the processor to be run.
+ *
+ * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+ */
+export type ProcessorId = string;

package/api/types/ProcessorId.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorOutput.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * The output from a processor run. The type of output will match the processor type.
+ */
+export type ProcessorOutput = Extend.ExtractionOutput | Extend.ClassifierOutput | Extend.SplitterOutput;

package/api/types/ProcessorOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorRun.d.ts

@@ -0,0 +1,77 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ProcessorRun {
+    /** The type of response. In this case, it will always be `"document_processor_run"`. */
+    object: string;
+    /**
+     * The unique identifier for this processor run.
+     *
+     * Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    id: string;
+    /**
+     * The ID of the processor used for this run.
+     *
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    processorId: string;
+    /** The ID of the specific processor version used. */
+    processorVersionId: string;
+    /**
+     * The name of the processor.
+     *
+     * Example: `"Invoice Processor"`
+     */
+    processorName: string;
+    /**
+     * The current status of the processor run:
+     * * `"PROCESSING"` - The processor is currently running
+     * * `"PROCESSED"` - The processor has completed successfully
+     * * `"FAILED"` - The processor encountered an error
+     */
+    status: Extend.ProcessorRunStatus;
+    /**
+     * The final output, either reviewed or initial.
+     *
+     * Conforms to the shape of output types and depends on the processor type and configuration shape.
+     */
+    output: Extend.ProcessorOutput;
+    /** If the run failed, indicates the reason for failure. */
+    failureReason?: string;
+    /** If the run failed, provides a detailed message about the failure. */
+    failureMessage?: string;
+    /** Any metadata that was provided when creating the processor run. */
+    metadata?: Extend.JsonObject;
+    /** Indicates whether the run has been reviewed. */
+    reviewed: boolean;
+    /** Indicates whether the run results have been edited. */
+    edited: boolean;
+    edits: Record<string, Extend.ExtractionOutputEdits>;
+    /**
+     * The type of processor:
+     * * `"CLASSIFY"` - Classifies documents into categories
+     * * `"EXTRACT"` - Extracts structured data from documents
+     * * `"SPLITTER"` - Splits documents into multiple parts
+     */
+    type: Extend.ProcessorRunType;
+    /** The configuration used for this processor run. The type of configuration will match the processor type. */
+    config: Extend.ProcessorRunConfig;
+    /** The initial output from the processor run. The type of output will match the processor type. */
+    initialOutput?: Extend.ProcessorOutput;
+    /** The output after review, if any. */
+    reviewedOutput?: Extend.ProcessorOutput;
+    /**
+     * Details of the processed files.
+     *
+     * If this was a file generated from a splitter processor, this will be the sub file.
+     *
+     * See the File object for more details.
+     */
+    files: Extend.File_[];
+    /** An array of processors that were merged to create this output. Will be an empty array unless this output was the result of a MergeExtraction step in a workflow. */
+    mergedProcessors: Extend.ProcessorRunMergedProcessorsItem[];
+    /** The URL to view the processor run. */
+    url: string;
+}

package/api/types/ProcessorRun.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorRunConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * The configuration used for this processor run. The type of configuration will match the processor type.
+ */
+export type ProcessorRunConfig = Extend.ProcessorRunConfig.Classify | Extend.ProcessorRunConfig.Extract | Extend.ProcessorRunConfig.Splitter;
+export declare namespace ProcessorRunConfig {
+    interface Classify extends Extend.ClassificationConfig {
+        type: "CLASSIFY";
+    }
+    interface Extract extends Extend.ExtractionConfig {
+        type: "EXTRACT";
+    }
+    interface Splitter extends Extend.SplitterConfig {
+        type: "SPLITTER";
+    }
+}

package/api/types/ProcessorRunConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorRunFileInput.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input file for running a single processor.
+ */
+export interface ProcessorRunFileInput {
+    /** The name of the file to be processed. If not provided, the file name will be inferred from the URL. It is highly recommended to include this parameter for legibility. */
+    fileName?: string;
+    /** A URL where the file can be downloaded from. If you use presigned URLs, we recommend an expiration time of 5-15 minutes. One of a `fileUrl` or `fileId` must be provided. */
+    fileUrl?: string;
+    /** Extend's internal ID for the file. It will always start with `file_`. One of a `fileUrl` or `fileId` must be provided. You can view a file ID from the Extend UI, for instance from running a parser or from a previous file creation. If you provide a `fileId`, any parsed data will be reused. */
+    fileId?: string;
+}

package/api/types/ProcessorRunFileInput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorRunMergedProcessorsItem.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ProcessorRunMergedProcessorsItem {
+    /**
+     * The ID of the merged processor.
+     *
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    processorId: string;
+    /** The ID of the specific processor version used. */
+    processorVersionId: string;
+    /**
+     * The name of the merged processor.
+     *
+     * Example: `"Invoice Line Items Processor"`
+     */
+    processorName: string;
+}

package/api/types/ProcessorRunMergedProcessorsItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorRunStatus.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The current status of the processor run:
+ * * `"PROCESSING"` - The processor is currently running
+ * * `"PROCESSED"` - The processor has completed successfully
+ * * `"FAILED"` - The processor encountered an error
+ */
+export type ProcessorRunStatus = "PROCESSING" | "PROCESSED" | "FAILED";
+export declare const ProcessorRunStatus: {
+    readonly Processing: "PROCESSING";
+    readonly Processed: "PROCESSED";
+    readonly Failed: "FAILED";
+};

package/api/types/ProcessorRunStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorRunStatus = void 0;
+exports.ProcessorRunStatus = {
+    Processing: "PROCESSING",
+    Processed: "PROCESSED",
+    Failed: "FAILED",
+};

package/api/types/ProcessorRunType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of processor:
+ * * `"CLASSIFY"` - Classifies documents into categories
+ * * `"EXTRACT"` - Extracts structured data from documents
+ * * `"SPLITTER"` - Splits documents into multiple parts
+ */
+export type ProcessorRunType = "CLASSIFY" | "EXTRACT" | "SPLITTER";
+export declare const ProcessorRunType: {
+    readonly Classify: "CLASSIFY";
+    readonly Extract: "EXTRACT";
+    readonly Splitter: "SPLITTER";
+};

package/api/types/ProcessorRunType.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorRunType = void 0;
+exports.ProcessorRunType = {
+    Classify: "CLASSIFY",
+    Extract: "EXTRACT",
+    Splitter: "SPLITTER",
+};

package/api/types/ProcessorType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of processor:
+ * * `"EXTRACT"` - Extracts structured data from documents
+ * * `"CLASSIFY"` - Classifies documents into categories
+ * * `"SPLITTER"` - Splits documents into multiple parts
+ */
+export type ProcessorType = "EXTRACT" | "CLASSIFY" | "SPLITTER";
+export declare const ProcessorType: {
+    readonly Extract: "EXTRACT";
+    readonly Classify: "CLASSIFY";
+    readonly Splitter: "SPLITTER";
+};

package/api/types/ProcessorType.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorType = void 0;
+exports.ProcessorType = {
+    Extract: "EXTRACT",
+    Classify: "CLASSIFY",
+    Splitter: "SPLITTER",
+};

package/api/types/ProcessorVersion.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ProcessorVersion {
+    /** The type of the object. In this case, it will always be `"document_processor_version"`. */
+    object: string;
+    /**
+     * The unique identifier for this version of the document processor.
+     *
+     * Example: `"dpv_xK9mLPqRtN3vS8wF5hB2cQ"`
+     */
+    id: string;
+    /**
+     * The ID of the parent document processor.
+     *
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    processorId: string;
+    /**
+     * The name of the parent document processor.
+     *
+     * Example: `"Invoice Processor"`
+     */
+    processorName?: string;
+    processorType: Extend.ProcessorType;
+    /**
+     * An optional description of this version of the document processor.
+     *
+     * Example: `"Updated extraction fields for new invoice format"`
+     */
+    description?: string;
+    /**
+     * The version number or identifier for this specific version of the document processor. The draft version will have version="draft".
+     *
+     * Examples: `"1.0"`, `"2.1"`, `"draft"`
+     */
+    version: string;
+    /**
+     * The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.
+     *
+     * See the [Processor Configs guide](https://docs.extend.ai/2025-04-21/developers/guides/processor-configs) for more details on the configuration settings for each processor type.
+     */
+    config: Extend.ProcessorVersionConfig;
+    /**
+     * The time (in UTC) at which this version of the document processor was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    createdAt: string;
+    /**
+     * The time (in UTC) at which this version of the document processor was last updated. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    updatedAt: string;
+}

package/api/types/ProcessorVersion.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessorVersionConfig.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.
+ *
+ * See the [Processor Configs guide](https://docs.extend.ai/2025-04-21/developers/guides/processor-configs) for more details on the configuration settings for each processor type.
+ */
+export type ProcessorVersionConfig = Extend.ProcessorVersionConfig.Classify | Extend.ProcessorVersionConfig.Extract | Extend.ProcessorVersionConfig.Splitter;
+export declare namespace ProcessorVersionConfig {
+    interface Classify extends Extend.ClassificationConfig {
+        type: "CLASSIFY";
+    }
+    interface Extract extends Extend.ExtractionConfig {
+        type: "EXTRACT";
+    }
+    interface Splitter extends Extend.SplitterConfig {
+        type: "SPLITTER";
+    }
+}

package/api/types/ProcessorVersionConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedClassifierOutput.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ProvidedClassifierOutput {
+    /** The unique identifier for this classification */
+    id: string;
+    /** The type of classification */
+    type: string;
+    /** A value between 0 and 1 indicating the model's confidence in the classification, where 1 represents maximum confidence */
+    confidence?: number;
+}

package/api/types/ProvidedClassifierOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedExtractionFieldResult.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ProvidedExtractionFieldResult {
+    /** The unique identifier for this field */
+    id: string;
+    value?: unknown;
+    /** The type of the extraction field result */
+    type?: Extend.ProvidedExtractionFieldResultType;
+    /** A value between 0 and 1 indicating confidence in the extraction. Will be set to 1 if not provided. */
+    confidence?: number;
+    /** The page number where this field was extracted from */
+    page?: number;
+}

package/api/types/ProvidedExtractionFieldResult.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedExtractionFieldResultType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of the extraction field result
+ */
+export type ProvidedExtractionFieldResultType = "string" | "number" | "currency" | "boolean" | "date" | "array" | "enum" | "object" | "signature";
+export declare const ProvidedExtractionFieldResultType: {
+    readonly String: "string";
+    readonly Number: "number";
+    readonly Currency: "currency";
+    readonly Boolean: "boolean";
+    readonly Date: "date";
+    readonly Array: "array";
+    readonly Enum: "enum";
+    readonly Object: "object";
+    readonly Signature: "signature";
+};

package/api/types/ProvidedExtractionFieldResultType.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvidedExtractionFieldResultType = void 0;
+exports.ProvidedExtractionFieldResultType = {
+    String: "string",
+    Number: "number",
+    Currency: "currency",
+    Boolean: "boolean",
+    Date: "date",
+    Array: "array",
+    Enum: "enum",
+    Object: "object",
+    Signature: "signature",
+};

package/api/types/ProvidedExtractionOutput.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export type ProvidedExtractionOutput = Extend.ProvidedJsonOutput | Extend.ProvidedFieldsArrayOutput;

package/api/types/ProvidedExtractionOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedFieldsArrayOutput.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * A mapping of field names to their extracted values
+ */
+export type ProvidedFieldsArrayOutput = Record<string, Extend.ProvidedExtractionFieldResult>;

package/api/types/ProvidedFieldsArrayOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedJsonOutput.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The output from a JSON Schema processor
+ */
+export interface ProvidedJsonOutput {
+    value: Record<string, unknown>;
+}

package/api/types/ProvidedJsonOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedProcessorOutput.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export type ProvidedProcessorOutput = Extend.ProvidedExtractionOutput | Extend.ProvidedClassifierOutput | Extend.ProvidedSplitterOutput;

package/api/types/ProvidedProcessorOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedSplitterOutput.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ProvidedSplitterOutput {
+    splits: Extend.ProvidedSplitterOutputSplitsItem[];
+}

package/api/types/ProvidedSplitterOutput.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProvidedSplitterOutputSplitsItem.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ProvidedSplitterOutputSplitsItem {
+    /** Unique ID for this split */
+    id: string;
+    /** ID of the classification type (set in the processor config) */
+    classificationId: string;
+    /** The type of the split document (set in the processor config), corresponds to the classificationId */
+    type: string;
+    /** Explanation of the results */
+    observation?: string;
+    /** Identifier for the split document (e.g. invoice number) */
+    identifier?: string;
+    /** The start page of the split document */
+    startPage: number;
+    /** The end page of the split document */
+    endPage: number;
+}

package/api/types/ProvidedSplitterOutputSplitsItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });