extend-ai 0.0.1-beta

package/api/types/File_.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface File_ {
+    /** The type of response. In this case, it will always be "file". */
+    object: string;
+    /**
+     * Extend's internal ID for the file. It will always start with `"file_"`.
+     *
+     * Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
+     */
+    id: string;
+    /**
+     * The name of the file
+     *
+     * Example: `"Invoices.pdf"`
+     */
+    name: string;
+    /** The type of the file */
+    type?: Extend.FileType;
+    /** A presigned URL to download the file. Expires after 15 minutes. */
+    presignedUrl?: string;
+    /** The ID of the parent file. Only included if this file is a derivative of another file, for instance if it was created via a Splitter in a workflow. */
+    parentFileId?: string;
+    contents?: Extend.FileContents;
+    metadata: Extend.FileMetadata;
+    /**
+     * The time (in UTC) at which the file was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    createdAt: string;
+    /**
+     * The time (in UTC) at which the file was last updated. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    updatedAt: string;
+}

package/api/types/File_.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/Insight.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Insight {
+    /** The type of insight. Will always be `"reasoning"` for now. */
+    type: "reasoning";
+    /** The content of the reasoning insight. */
+    content: string;
+}

package/api/types/Insight.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/JsonObject.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A flexible object that can hold any arbitrary JSON key-value structure.
+ */
+export type JsonObject = Record<string, unknown>;

package/api/types/JsonObject.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/JsonOutput.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface JsonOutput {
+    /** The extracted values conforming to the schema defined in the processor config */
+    value: Extend.JsonObject;
+    /** Metadata about the extracted fields */
+    metadata: Record<string, Extend.JsonOutputMetadataValue>;
+}

package/api/types/JsonOutput.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/JsonOutputMetadataValue.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface JsonOutputMetadataValue {
+    /** Confidence score from OCR processing, if applicable */
+    ocrConfidence?: number;
+    /** Confidence score based on model logprobs */
+    logprobsConfidence?: number;
+    citations?: Extend.JsonOutputMetadataValueCitationsItem[];
+    insights?: Extend.JsonOutputMetadataValueInsightsItem[];
+}

package/api/types/JsonOutputMetadataValue.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/JsonOutputMetadataValueCitationsItem.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface JsonOutputMetadataValueCitationsItem {
+    /** Page number where the citation was found */
+    page?: number;
+    /** The text that was referenced */
+    referenceText?: string;
+    /** Array of points defining the polygon around the referenced text */
+    polygon?: Extend.JsonOutputMetadataValueCitationsItemPolygonItem[];
+}

package/api/types/JsonOutputMetadataValueCitationsItem.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/JsonOutputMetadataValueCitationsItemPolygonItem.d.ts

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

package/api/types/JsonOutputMetadataValueCitationsItemPolygonItem.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/JsonOutputMetadataValueInsightsItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface JsonOutputMetadataValueInsightsItem {
+    /** The type of insight */
+    type: "reasoning";
+    /** The content of the insight */
+    content: string;
+}

package/api/types/JsonOutputMetadataValueInsightsItem.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/MaxPageSize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.
+ */
+export type MaxPageSize = number;

package/api/types/MaxPageSize.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/NextPageToken.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a `nextPageToken` in the response if there are more results.
+ *
+ * Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.
+ *
+ * example: `"xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="`
+ */
+export type NextPageToken = string;

package/api/types/NextPageToken.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/OutputMetadata.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export type OutputMetadata = Record<string, Extend.OutputMetadataValue>;

package/api/types/OutputMetadata.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/OutputMetadataValue.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface OutputMetadataValue {
+    /** Confidence score from OCR processing, if applicable */
+    ocrConfidence?: number;
+    /** Confidence score based on model logprobs */
+    logprobsConfidence?: number;
+    citations?: Extend.Citation[];
+    insights?: Extend.Insight[];
+}

package/api/types/OutputMetadataValue.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/ParseConfig.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Configuration options for the parsing process.
+ */
+export interface ParseConfig {
+    /**
+     * The target format for the parsed content. Supported values:
+     *
+     * * `markdown`: Convert document to Markdown format
+     * * `spatial`: Preserve spatial information in the output
+     */
+    target?: Extend.ParseConfigTarget;
+    /** Strategy for dividing the document into chunks. */
+    chunkingStrategy?: Extend.ParseConfigChunkingStrategy;
+    /** Options for controlling how different block types are processed. */
+    blockOptions?: Extend.ParseConfigBlockOptions;
+    advancedOptions?: Extend.ParseConfigAdvancedOptions;
+}

package/api/types/ParseConfig.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/ParseConfigAdvancedOptions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ParseConfigAdvancedOptions {
+    /** Whether to automatically detect and correct page rotation. */
+    pageRotationEnabled?: boolean;
+}

package/api/types/ParseConfigAdvancedOptions.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/ParseConfigBlockOptions.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Options for controlling how different block types are processed.
+ */
+export interface ParseConfigBlockOptions {
+    /** Options for figure blocks. */
+    figures?: Extend.ParseConfigBlockOptionsFigures;
+    /** Options for table blocks. */
+    tables?: Extend.ParseConfigBlockOptionsTables;
+    /** Options for text blocks. */
+    text?: Extend.ParseConfigBlockOptionsText;
+}

package/api/types/ParseConfigBlockOptions.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/ParseConfigBlockOptionsFigures.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Options for figure blocks.
+ */
+export interface ParseConfigBlockOptionsFigures {
+    /** Whether to include figures in the output. */
+    enabled?: boolean;
+    /** Whether to clip and extract images from figures. */
+    figureImageClippingEnabled?: boolean;
+}

package/api/types/ParseConfigBlockOptionsFigures.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/ParseConfigBlockOptionsTables.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Options for table blocks.
+ */
+export interface ParseConfigBlockOptionsTables {
+    /** Whether to include tables in the output. */
+    enabled?: boolean;
+    /**
+     * The target format for the table blocks. Supported values:
+     * * `markdown`: Convert table to Markdown format
+     * * `html`: Convert table to HTML format
+     */
+    targetFormat?: Extend.ParseConfigBlockOptionsTablesTargetFormat;
+}

package/api/types/ParseConfigBlockOptionsTables.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/ParseConfigBlockOptionsTablesTargetFormat.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The target format for the table blocks. Supported values:
+ * * `markdown`: Convert table to Markdown format
+ * * `html`: Convert table to HTML format
+ */
+export type ParseConfigBlockOptionsTablesTargetFormat = "markdown" | "html";
+export declare const ParseConfigBlockOptionsTablesTargetFormat: {
+    readonly Markdown: "markdown";
+    readonly Html: "html";
+};

package/api/types/ParseConfigBlockOptionsTablesTargetFormat.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.ParseConfigBlockOptionsTablesTargetFormat = void 0;
+exports.ParseConfigBlockOptionsTablesTargetFormat = {
+    Markdown: "markdown",
+    Html: "html",
+};

package/api/types/ParseConfigBlockOptionsText.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Options for text blocks.
+ */
+export interface ParseConfigBlockOptionsText {
+    /** Whether an additional vision model will be utilized for advanced signature detection. Recommended for most use cases, but should be disabled if signature detection is not necessary and latency is a concern. */
+    signatureDetectionEnabled?: boolean;
+}

package/api/types/ParseConfigBlockOptionsText.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/ParseConfigChunkingStrategy.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Strategy for dividing the document into chunks.
+ */
+export interface ParseConfigChunkingStrategy {
+    /**
+     * The type of chunking strategy. Supported values:
+     *
+     * * `page`: Chunk document by pages.
+     * * `document`: Entire document is a single chunk. Essentially no chunking.
+     * * `section`: Split by logical sections. Not supported for target=spatial.
+     */
+    type?: Extend.ParseConfigChunkingStrategyType;
+    /** Specify a minimum number of characters per chunk. */
+    minCharacters?: number;
+    /** Specify a maximum number of characters per chunk. */
+    maxCharacters?: number;
+}

package/api/types/ParseConfigChunkingStrategy.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/ParseConfigChunkingStrategyType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of chunking strategy. Supported values:
+ *
+ * * `page`: Chunk document by pages.
+ * * `document`: Entire document is a single chunk. Essentially no chunking.
+ * * `section`: Split by logical sections. Not supported for target=spatial.
+ */
+export type ParseConfigChunkingStrategyType = "page" | "document" | "section";
+export declare const ParseConfigChunkingStrategyType: {
+    readonly Page: "page";
+    readonly Document: "document";
+    readonly Section: "section";
+};

package/api/types/ParseConfigChunkingStrategyType.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.ParseConfigChunkingStrategyType = void 0;
+exports.ParseConfigChunkingStrategyType = {
+    Page: "page",
+    Document: "document",
+    Section: "section",
+};

package/api/types/ParseConfigTarget.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The target format for the parsed content. Supported values:
+ *
+ * * `markdown`: Convert document to Markdown format
+ * * `spatial`: Preserve spatial information in the output
+ */
+export type ParseConfigTarget = "markdown" | "spatial";
+export declare const ParseConfigTarget: {
+    readonly Markdown: "markdown";
+    readonly Spatial: "spatial";
+};

package/api/types/ParseConfigTarget.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.ParseConfigTarget = void 0;
+exports.ParseConfigTarget = {
+    Markdown: "markdown",
+    Spatial: "spatial",
+};

package/api/types/ParseError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ParseError {
+    code?: Extend.ParseErrorCode;
+    message?: string;
+    requestId?: string;
+    retryable?: boolean;
+}

package/api/types/ParseError.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/ParseErrorCode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ParseErrorCode = "INVALID_CONFIG_OPTIONS" | "UNABLE_TO_DOWNLOAD_FILE" | "FILE_TYPE_NOT_SUPPORTED" | "FILE_SIZE_TOO_LARGE" | "CORRUPT_FILE" | "OCR_ERROR" | "PASSWORD_PROTECTED_FILE" | "FAILED_TO_CONVERT_TO_PDF" | "FAILED_TO_GENERATE_TARGET_FORMAT" | "INTERNAL_ERROR";
+export declare const ParseErrorCode: {
+    readonly InvalidConfigOptions: "INVALID_CONFIG_OPTIONS";
+    readonly UnableToDownloadFile: "UNABLE_TO_DOWNLOAD_FILE";
+    readonly FileTypeNotSupported: "FILE_TYPE_NOT_SUPPORTED";
+    readonly FileSizeTooLarge: "FILE_SIZE_TOO_LARGE";
+    readonly CorruptFile: "CORRUPT_FILE";
+    readonly OcrError: "OCR_ERROR";
+    readonly PasswordProtectedFile: "PASSWORD_PROTECTED_FILE";
+    readonly FailedToConvertToPdf: "FAILED_TO_CONVERT_TO_PDF";
+    readonly FailedToGenerateTargetFormat: "FAILED_TO_GENERATE_TARGET_FORMAT";
+    readonly InternalError: "INTERNAL_ERROR";
+};

package/api/types/ParseErrorCode.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseErrorCode = void 0;
+exports.ParseErrorCode = {
+    InvalidConfigOptions: "INVALID_CONFIG_OPTIONS",
+    UnableToDownloadFile: "UNABLE_TO_DOWNLOAD_FILE",
+    FileTypeNotSupported: "FILE_TYPE_NOT_SUPPORTED",
+    FileSizeTooLarge: "FILE_SIZE_TOO_LARGE",
+    CorruptFile: "CORRUPT_FILE",
+    OcrError: "OCR_ERROR",
+    PasswordProtectedFile: "PASSWORD_PROTECTED_FILE",
+    FailedToConvertToPdf: "FAILED_TO_CONVERT_TO_PDF",
+    FailedToGenerateTargetFormat: "FAILED_TO_GENERATE_TARGET_FORMAT",
+    InternalError: "INTERNAL_ERROR",
+};

package/api/types/ParseRequestFile.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A file object containing either a URL or a fileId.
+ */
+export interface ParseRequestFile {
+    /** The name of the file. If not set, the file name is taken from the url. */
+    fileName?: string;
+    /** A URL to download the file. For production use cases, we recommend using presigned URLs with a 5-15 minute expiration time. One of `fileUrl` or `fileId` must be provided. */
+    fileUrl?: string;
+    /**
+     * If you already have an Extend file id (for instance from running a workflow or a previous [file upload](https://docs.extend.ai/2025-04-21/developers/api-reference/file-endpoints/upload-file)) then you can use that file id when running the parse endpoint so that it leverage any cached data that might be available. The file id will start with "file_". One of `fileUrl` or `fileId` must be provided.
+     *
+     * Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
+     */
+    fileId?: string;
+}

package/api/types/ParseRequestFile.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/ParseResponse.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ParseResponse {
+    /** The type of object. Will always be `"parser_run"`. */
+    object: "parser_run";
+    /**
+     * A unique identifier for the parser run. Will always start with `"parser_run_"`
+     *
+     * Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
+     */
+    id: string;
+    /** The identifier of the file that was parsed. This can be used as a parameter to other Extend endpoints, such as processor runs. This allows downstream processing to reuse a cache of the parsed file content to reduce your usage costs. */
+    fileId: string;
+    /** An array of chunks that were parsed from the file. */
+    chunks: Extend.Chunk[];
+    /**
+     * The status of the parser run:
+     * * `"PROCESSED"` - The file was successfully processed
+     * * `"FAILED"` - The processing failed (see failureReason for details)
+     */
+    status: Extend.ParseResponseStatus;
+    /** The reason for failure if status is "FAILED". */
+    failureReason?: string;
+    /** Metrics about the parsing process. */
+    metrics: Extend.ParseResponseMetrics;
+    /** The configuration used for the parsing process, including any default values that were applied. */
+    config: Extend.ParseConfig;
+}

package/api/types/ParseResponse.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/ParseResponseMetrics.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Metrics about the parsing process.
+ */
+export interface ParseResponseMetrics {
+    /** The time taken to process the document in milliseconds. */
+    processingTimeMs: number;
+    /** The number of pages in the document. */
+    pageCount: number;
+}

package/api/types/ParseResponseMetrics.js

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