extend-ai 0.0.1-beta

package/dist/api/types/WebhookEventProcessorVersion.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/dist/api/types/WebhookEventWorkflow.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Webhook event for workflow related events
+ */
+export interface WebhookEventWorkflow {
+    eventType?: Extend.WebhookEventWorkflowEventType;
+    payload?: Extend.Workflow;
+    /** Unique identifier for the event */
+    eventId: string;
+}

package/dist/api/types/WebhookEventWorkflow.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/dist/api/types/WebhookEventWorkflowEventType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type WebhookEventWorkflowEventType = "workflow.created" | "workflow.deployed" | "workflow.deleted";
+export declare const WebhookEventWorkflowEventType: {
+    readonly WorkflowCreated: "workflow.created";
+    readonly WorkflowDeployed: "workflow.deployed";
+    readonly WorkflowDeleted: "workflow.deleted";
+};

package/dist/api/types/WebhookEventWorkflowEventType.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.WebhookEventWorkflowEventType = void 0;
+exports.WebhookEventWorkflowEventType = {
+    WorkflowCreated: "workflow.created",
+    WorkflowDeployed: "workflow.deployed",
+    WorkflowDeleted: "workflow.deleted",
+};

package/dist/api/types/WebhookEventWorkflowRun.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Webhook event for workflow run related events
+ */
+export interface WebhookEventWorkflowRun {
+    eventType?: Extend.WebhookEventWorkflowRunEventType;
+    payload?: Extend.WorkflowRun;
+    /** Unique identifier for the event */
+    eventId: string;
+}

package/dist/api/types/WebhookEventWorkflowRun.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/dist/api/types/WebhookEventWorkflowRunEventType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type WebhookEventWorkflowRunEventType = "workflow_run.completed" | "workflow_run.failed" | "workflow_run.needs_review" | "workflow_run.rejected" | "workflow_run.step_run.processed";
+export declare const WebhookEventWorkflowRunEventType: {
+    readonly WorkflowRunCompleted: "workflow_run.completed";
+    readonly WorkflowRunFailed: "workflow_run.failed";
+    readonly WorkflowRunNeedsReview: "workflow_run.needs_review";
+    readonly WorkflowRunRejected: "workflow_run.rejected";
+    readonly WorkflowRunStepRunProcessed: "workflow_run.step_run.processed";
+};

package/dist/api/types/WebhookEventWorkflowRunEventType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookEventWorkflowRunEventType = void 0;
+exports.WebhookEventWorkflowRunEventType = {
+    WorkflowRunCompleted: "workflow_run.completed",
+    WorkflowRunFailed: "workflow_run.failed",
+    WorkflowRunNeedsReview: "workflow_run.needs_review",
+    WorkflowRunRejected: "workflow_run.rejected",
+    WorkflowRunStepRunProcessed: "workflow_run.step_run.processed",
+};

package/dist/api/types/Workflow.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Workflow {
+    /** The type of response. In this case, it will always be `"workflow"`. */
+    object: string;
+    /**
+     * The ID of the workflow.
+     *
+     * Example: `"workflow_BMlfq_yWM3sT-ZzvCnA3f"`
+     */
+    id: string;
+    /**
+     * The version of the workflow.
+     *
+     * Examples: `"3"`, `"draft"`
+     */
+    version: string;
+    /**
+     * The name of the workflow.
+     *
+     * Example: `"Invoice Processing"`
+     */
+    name: string;
+}

package/dist/api/types/Workflow.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/dist/api/types/WorkflowRun.d.ts

@@ -0,0 +1,86 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface WorkflowRun {
+    /** The type of response. In this case, it will always be `"workflow_run"`. */
+    object: string;
+    /**
+     * The ID of the workflow run.
+     *
+     * Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
+     */
+    id: string;
+    /**
+     * The name of the workflow run.
+     *
+     * Example: `"myFirstFile.pdf"`
+     */
+    name: string;
+    /**
+     * A URL to view this workflow run in the Extend UI.
+     *
+     * Example: `"https://dashboard.extend.ai/workflows/workflow_Bk9mNp2qWs5_xL8vR4tYh?workflowRunId=workflow_run_Zj3nMx7ZPd9f4c2WQ_kAg"`
+     */
+    url: string;
+    status: Extend.WorkflowStatus;
+    /** The metadata that was passed in when running the Workflow. */
+    metadata: Extend.JsonObject;
+    /**
+     * The batch ID of the WorkflowRun. If this WorkflowRun was created as part of a batch of files, all runs in that batch will have the same batch ID.
+     *
+     * Example: `"batch_7Ws31-F5"`
+     */
+    batchId?: string;
+    files: Extend.File_[];
+    /** The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED". */
+    failureReason?: string;
+    /** A more detailed message about the failure. Will only be included if the workflow run status is "FAILED". */
+    failureMessage?: string;
+    /**
+     * The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2025-04-28T17:01:39.285Z"`
+     */
+    initialRunAt: string;
+    /**
+     * The email address of the person who reviewed the workflow run. Will not be included if the workflow run has not been reviewed.
+     *
+     * Example: `"jane.doe@example.com"`
+     */
+    reviewedBy?: string;
+    /** Whether the workflow run has been reviewed. */
+    reviewed: boolean;
+    /**
+     * A note that is added if a workflow run is rejected.
+     *
+     * Example: `"Invalid invoice format"`
+     */
+    rejectionNote?: string;
+    /**
+     * The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will not be included if the workflow run has not been reviewed.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    reviewedAt?: string;
+    /**
+     * The time (in UTC) at which the workflow run started executing. This will always be after the `initialRunAt` time. Will follow the RFC 3339 format. Will not be included if the workflow run has not started executing.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    startTime?: string;
+    /**
+     * The time (in UTC) that the workflow finished executing. Will follow the RFC 3339 format. Will not be included if the workflow run has not finished executing.
+     *
+     * Example: `"2024-03-21T15:35:00Z"`
+     */
+    endTime?: string;
+    outputs: Extend.ProcessorRun[];
+    /**
+     * An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run's output.
+     *
+     * Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.
+     */
+    stepRuns: Extend.StepRun[];
+    workflow: Extend.Workflow;
+}

package/dist/api/types/WorkflowRun.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/dist/api/types/WorkflowRunFileInput.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * A file object that can be specified using either a URL or an existing file ID for workflow runs.
+ */
+export interface WorkflowRunFileInput {
+    /** 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.
+     *
+     * Example: `"file_Zk9mNP12Qw4yTv8BdR3H"`
+     */
+    fileId?: string;
+    /** Predetermined outputs that can be used to override the outputs that are generated. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known. */
+    outputs?: Extend.WorkflowRunFileInputOutputsItem[];
+}

package/dist/api/types/WorkflowRunFileInput.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/dist/api/types/WorkflowRunFileInputOutputsItem.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface WorkflowRunFileInputOutputsItem {
+    /**
+     * The ID of the processor that the output is associated with.
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    processorId: string;
+    /** The output that is being overridden. The structure will depend on the processor type. More details can be found [here](https://docs.extend.ai/2025-04-21/developers/guides/output-types). */
+    output: Extend.ProvidedProcessorOutput;
+}

package/dist/api/types/WorkflowRunFileInputOutputsItem.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/dist/api/types/WorkflowRunSummary.d.ts

@@ -0,0 +1,85 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface WorkflowRunSummary {
+    /**
+     * The ID of the workflow run.
+     *
+     * Example: `"workflow_run_Zk9mNP12Qw4-yTv8BdR3H"`
+     */
+    id: string;
+    status: Extend.WorkflowStatus;
+    /**
+     * The time (in UTC) at which the workflow was initially created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    initialRunAt?: string;
+    /**
+     * The user of the person who reviewed the workflow run. Will not be included if the workflow run has not been reviewed.
+     *
+     * Example: `"jane.doe@example.com"`
+     */
+    reviewedByUser?: string;
+    /**
+     * The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    reviewedAt?: string;
+    /**
+     * The start time (in UTC) that the workflow actually started executing. This occurs after the `initialRunAt` time. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    startTime?: string;
+    /**
+     * The end time (in UTC) that the workflow finished. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:35:00Z"`
+     */
+    endTime?: string;
+    /**
+     * The ID of the workflow that was run. Will always start with "workflow".
+     *
+     * Example: `"workflow_BMdfq_yWM3sT-ZzvCnA3f"`
+     */
+    workflowId: string;
+    /**
+     * The name of the workflow that was run.
+     *
+     * Example: `"Invoice Processing"`
+     */
+    workflowName: string;
+    /**
+     * The ID of the workflow version that was run. Will always start with "workflow_version".
+     *
+     * Example: `"workflow_version_Zk9mNP12Qw4-yTv8BdR3H"`
+     */
+    workflowVersionId: string;
+    /**
+     * The batch ID of the WorkflowRun. If that WorkflowRun was created from a batch of files, all runs in that batch will have the same batch ID.
+     *
+     * Example: `"batch_7Ws31-F5"`
+     */
+    batchId?: string;
+    /**
+     * The note that was added when the workflow run was rejected.
+     *
+     * Example: `"Invalid invoice format"`
+     */
+    rejectionNote?: string;
+    /**
+     * The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:29:55Z"`
+     */
+    createdAt: string;
+    /**
+     * The time (in UTC) at which the workflow run was last updated. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    updatedAt: string;
+}

package/dist/api/types/WorkflowRunSummary.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/dist/api/types/WorkflowStatus.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of a workflow run:
+ * * `"PENDING"` - The workflow run is in progress
+ * * `"PROCESSING"` - The workflow run completed successfully
+ * * `"NEEDS_REVIEW"` - The workflow run requires manual review
+ * * `"REJECTED"` - The workflow run was rejected during review
+ * * `"PROCESSED"` - The workflow run completed successfully
+ * * `"FAILED"` - The workflow run encountered an error
+ */
+export type WorkflowStatus = "PENDING" | "PROCESSING" | "NEEDS_REVIEW" | "REJECTED" | "PROCESSED" | "FAILED";
+export declare const WorkflowStatus: {
+    readonly Pending: "PENDING";
+    readonly Processing: "PROCESSING";
+    readonly NeedsReview: "NEEDS_REVIEW";
+    readonly Rejected: "REJECTED";
+    readonly Processed: "PROCESSED";
+    readonly Failed: "FAILED";
+};

package/dist/api/types/WorkflowStatus.js

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

package/dist/api/types/index.d.ts

@@ -0,0 +1,145 @@
+export * from "./ParseRequestFile";
+export * from "./ParseResponseStatus";
+export * from "./ParseResponseMetrics";
+export * from "./ParseResponse";
+export * from "./BadRequestErrorBodyCode";
+export * from "./BadRequestErrorBody";
+export * from "./Error_";
+export * from "./WorkflowStatus";
+export * from "./WorkflowRun";
+export * from "./JsonObject";
+export * from "./StepRunStatus";
+export * from "./StepRunStepType";
+export * from "./StepRunStep";
+export * from "./StepRunOutputRulesItemFailureReason";
+export * from "./StepRunOutputRulesItem";
+export * from "./StepRunOutput";
+export * from "./StepRun";
+export * from "./Workflow";
+export * from "./ProcessorRunStatus";
+export * from "./ProcessorRunType";
+export * from "./ProcessorRunConfig";
+export * from "./ProcessorRunMergedProcessorsItem";
+export * from "./ProcessorRun";
+export * from "./ExtractionOutputEdits";
+export * from "./Processor";
+export * from "./ProcessorVersionConfig";
+export * from "./ProcessorVersion";
+export * from "./EvaluationSet";
+export * from "./EvaluationSetItem";
+export * from "./ChunkType";
+export * from "./ChunkMetadataPageRange";
+export * from "./ChunkMetadata";
+export * from "./Chunk";
+export * from "./TableDetails";
+export * from "./TableCellDetails";
+export * from "./FigureDetailsFigureType";
+export * from "./FigureDetails";
+export * from "./EmptyBlockDetails";
+export * from "./BlockType";
+export * from "./BlockDetails";
+export * from "./BlockMetadataPage";
+export * from "./BlockMetadata";
+export * from "./BlockPolygonItem";
+export * from "./BlockBoundingBox";
+export * from "./Block";
+export * from "./BatchProcessorRunMetrics";
+export * from "./BatchProcessorRunStatus";
+export * from "./BatchProcessorRunSource";
+export * from "./BatchProcessorRunOptions";
+export * from "./BatchProcessorRun";
+export * from "./BaseMetrics";
+export * from "./ExtractMetricsFieldMetrics";
+export * from "./ExtractMetrics";
+export * from "./ClassifyMetrics";
+export * from "./SplitterMetrics";
+export * from "./WorkflowRunSummary";
+export * from "./ParseErrorCode";
+export * from "./ParseError";
+export * from "./WebhookEventEventType";
+export * from "./WebhookEventPayload";
+export * from "./WebhookEvent";
+export * from "./WebhookEventWorkflowRunEventType";
+export * from "./WebhookEventWorkflowRun";
+export * from "./WebhookEventProcessorRunEventType";
+export * from "./WebhookEventProcessorRun";
+export * from "./WebhookEventWorkflowEventType";
+export * from "./WebhookEventWorkflow";
+export * from "./WebhookEventProcessorEventType";
+export * from "./WebhookEventProcessor";
+export * from "./WebhookEventProcessorVersion";
+export * from "./ApiVersionEnum";
+export * from "./ProcessorId";
+export * from "./SortByEnum";
+export * from "./SortDirEnum";
+export * from "./NextPageToken";
+export * from "./MaxPageSize";
+export * from "./ProcessorType";
+export * from "./FileType";
+export * from "./FileContentsPagesItem";
+export * from "./FileContentsSheetsItem";
+export * from "./FileContents";
+export * from "./FileMetadataParentSplit";
+export * from "./FileMetadata";
+export * from "./File_";
+export * from "./WorkflowRunFileInputOutputsItem";
+export * from "./WorkflowRunFileInput";
+export * from "./ProcessorRunFileInput";
+export * from "./BatchWorkflowRunFileInput";
+export * from "./ClassificationConfigBaseProcessor";
+export * from "./ClassificationConfig";
+export * from "./Classification";
+export * from "./ClassificationAdvancedOptionsContext";
+export * from "./ClassificationAdvancedOptions";
+export * from "./ExtractionConfigBaseProcessor";
+export * from "./ExtractionConfig";
+export * from "./ExtractionAdvancedOptions";
+export * from "./ExtractChunkingOptionsChunkingStrategy";
+export * from "./ExtractChunkingOptionsChunkSelectionStrategy";
+export * from "./ExtractChunkingOptions";
+export * from "./ExtractionFieldType";
+export * from "./ExtractionField";
+export * from "./Enum";
+export * from "./SplitterConfig";
+export * from "./SplitterAdvancedOptionsSplitMethod";
+export * from "./SplitterAdvancedOptions";
+export * from "./ProvidedSplitterOutputSplitsItem";
+export * from "./ProvidedSplitterOutput";
+export * from "./SplitterOutputSplitsItem";
+export * from "./SplitterOutput";
+export * from "./ProvidedClassifierOutput";
+export * from "./ClassifierOutput";
+export * from "./ProvidedExtractionFieldResultType";
+export * from "./ProvidedExtractionFieldResult";
+export * from "./ProvidedFieldsArrayOutput";
+export * from "./ProvidedExtractionOutput";
+export * from "./ProvidedJsonOutput";
+export * from "./ExtractionOutput";
+export * from "./JsonOutputMetadataValueCitationsItemPolygonItem";
+export * from "./JsonOutputMetadataValueCitationsItem";
+export * from "./JsonOutputMetadataValueInsightsItem";
+export * from "./JsonOutputMetadataValue";
+export * from "./JsonOutput";
+export * from "./OutputMetadataValue";
+export * from "./OutputMetadata";
+export * from "./Citation";
+export * from "./Polygon";
+export * from "./FieldsArrayOutput";
+export * from "./ExtractionFieldResultType";
+export * from "./ExtractionFieldResult";
+export * from "./EnumOption";
+export * from "./ExtractionFieldResultReferenceBoundingBoxesItem";
+export * from "./ExtractionFieldResultReference";
+export * from "./Insight";
+export * from "./ProvidedProcessorOutput";
+export * from "./ProcessorOutput";
+export * from "./ParseConfigTarget";
+export * from "./ParseConfigChunkingStrategyType";
+export * from "./ParseConfigChunkingStrategy";
+export * from "./ParseConfigBlockOptionsFigures";
+export * from "./ParseConfigBlockOptionsTablesTargetFormat";
+export * from "./ParseConfigBlockOptionsTables";
+export * from "./ParseConfigBlockOptionsText";
+export * from "./ParseConfigBlockOptions";
+export * from "./ParseConfigAdvancedOptions";
+export * from "./ParseConfig";