extend-ai 0.0.1-beta

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The strategy to use for selecting chunks.
+ */
+export type ExtractChunkingOptionsChunkSelectionStrategy = "intelligent" | "confidence" | "take_first" | "take_last";
+export declare const ExtractChunkingOptionsChunkSelectionStrategy: {
+    readonly Intelligent: "intelligent";
+    readonly Confidence: "confidence";
+    readonly TakeFirst: "take_first";
+    readonly TakeLast: "take_last";
+};

package/dist/api/types/ExtractChunkingOptionsChunkSelectionStrategy.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractChunkingOptionsChunkSelectionStrategy = void 0;
+exports.ExtractChunkingOptionsChunkSelectionStrategy = {
+    Intelligent: "intelligent",
+    Confidence: "confidence",
+    TakeFirst: "take_first",
+    TakeLast: "take_last",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The strategy to use for chunking the document.
+ */
+export type ExtractChunkingOptionsChunkingStrategy = "standard" | "semantic";
+export declare const ExtractChunkingOptionsChunkingStrategy: {
+    readonly Standard: "standard";
+    readonly Semantic: "semantic";
+};

package/dist/api/types/ExtractChunkingOptionsChunkingStrategy.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.ExtractChunkingOptionsChunkingStrategy = void 0;
+exports.ExtractChunkingOptionsChunkingStrategy = {
+    Standard: "standard",
+    Semantic: "semantic",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Metrics specific to extraction processors
+ */
+export interface ExtractMetrics extends Extend.BaseMetrics {
+    /** The type of metrics. Will always be `"EXTRACT"` for extraction processors. */
+    type?: "EXTRACT";
+    /** Record mapping field names to their respective metrics. */
+    fieldMetrics?: Extend.ExtractMetricsFieldMetrics;
+    /** Maps the root array field name to a number indicating how many times the array field has the correct number of rows extracted. */
+    arrayCardinalityMetrics?: Record<string, unknown>;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Record mapping field names to their respective metrics.
+ */
+export interface ExtractMetricsFieldMetrics {
+    /** The mean confidence score for this field across all documents. */
+    meanConfidence?: number;
+    /** The recall percentage for this field, representing how many of the expected values were correctly extracted. */
+    recallPerc?: number;
+    /** The precision percentage for this field, representing how many of the extracted values were correct. */
+    precisionPerc?: number;
+    /** For nested object fields, this contains metrics for the child fields. Has the same structure as the parent fieldMetrics. */
+    fieldMetrics?: Record<string, unknown>;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractionAdvancedOptions {
+    /** The kind of document being processed. */
+    documentKind?: string;
+    /** Custom key definitions for extraction. */
+    keyDefinitions?: string;
+    /** Whether to enable model reasoning insights. */
+    modelReasoningInsightsEnabled?: boolean;
+    /** Whether to enable advanced multimodal features. */
+    advancedMultimodalEnabled?: boolean;
+    /** Whether to enable citations in the output. */
+    citationsEnabled?: boolean;
+    /** Whether to enable the auto-review assistant. */
+    autoReviewAssistantEnabled?: boolean;
+    /** Whether to enable advanced figure parsing. */
+    advancedFigureParsingEnabled?: boolean;
+    chunkingOptions?: Extend.ExtractChunkingOptions;
+    /** Optional fixed limit on the number of pages to process. */
+    fixedPageLimit?: number;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractionConfig {
+    /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See the [base processor documentation](https://docs.extend.ai/2025-04-21/changelog/overview) for more details. */
+    baseProcessor?: Extend.ExtractionConfigBaseProcessor;
+    /** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See the [base processor documentation](https://docs.extend.ai/2025-04-21/changelog/overview) for more details. */
+    baseVersion?: string;
+    /** Custom rules to guide the extraction process in natural language. */
+    extractionRules?: string;
+    /**
+     * JSON Schema definition of the data to extract. Either `fields` or `schema` must be provided.
+     *
+     * See the [schema documentation](https://docs.extend.ai/2025-04-21/developers/guides/processor-configs#json-schema-structure-schema) for details and examples of schema configuration.
+     */
+    schema?: Extend.JsonObject;
+    /**
+     * Array of fields to extract from the document. Either `fields` or `schema` must be provided.
+     *
+     * We recommend using `schema` for new implementations.
+     */
+    fields?: Extend.ExtractionField[];
+    /** Advanced configuration options. */
+    advancedOptions?: Extend.ExtractionAdvancedOptions;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See the [base processor documentation](https://docs.extend.ai/2025-04-21/changelog/overview) for more details.
+ */
+export type ExtractionConfigBaseProcessor = "extraction_performance" | "extraction_light";
+export declare const ExtractionConfigBaseProcessor: {
+    readonly ExtractionPerformance: "extraction_performance";
+    readonly ExtractionLight: "extraction_light";
+};

package/dist/api/types/ExtractionConfigBaseProcessor.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.ExtractionConfigBaseProcessor = void 0;
+exports.ExtractionConfigBaseProcessor = {
+    ExtractionPerformance: "extraction_performance",
+    ExtractionLight: "extraction_light",
+};

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractionField {
+    /** Unique identifier for the field. */
+    id: string;
+    /** Human-readable name for the field. */
+    name: string;
+    /** The type of the field. */
+    type: Extend.ExtractionFieldType;
+    /** Detailed description of the field, including expected content and format. */
+    description: string;
+    /** Required when type is "array" or "object". Contains nested field definitions. */
+    schema?: Extend.ExtractionField[];
+    /** Required when type is "enum". List of allowed values. */
+    enum?: Extend.Enum[];
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractionFieldResult {
+    /** The unique identifier for this field */
+    id: string;
+    /** The type of the extracted field */
+    type: Extend.ExtractionFieldResultType;
+    value?: unknown;
+    /** A value between 0 and 1 indicating confidence in the extraction */
+    confidence?: number;
+    /** The field schema of nested fields */
+    schema?: Extend.ExtractionField[];
+    /** Reasoning and other insights from the model */
+    insights?: Extend.Insight[];
+    /** References for the extracted field */
+    references: Extend.ExtractionFieldResultReference[];
+    /** The enum options for enum fields, only set when type=enum */
+    enum?: Extend.EnumOption[];
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractionFieldResultReference {
+    /** The unique identifier for this field */
+    id: string;
+    /** The name of the extracted field */
+    fieldName: string;
+    /** The page number that this bounding box is from */
+    page: number;
+    /** The bounding boxes of the field */
+    boundingBoxes: Extend.ExtractionFieldResultReferenceBoundingBoxesItem[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExtractionFieldResultReferenceBoundingBoxesItem {
+    /** The top coordinate of the bounding box */
+    top: number;
+    /** The left coordinate of the bounding box */
+    left: number;
+    /** The bottom coordinate of the bounding box */
+    bottom: number;
+    /** The right coordinate of the bounding box */
+    right: number;
+}

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

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

package/dist/api/types/ExtractionFieldResultType.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.ExtractionFieldResultType = void 0;
+exports.ExtractionFieldResultType = {
+    String: "string",
+    Number: "number",
+    Currency: "currency",
+    Boolean: "boolean",
+    Date: "date",
+    Enum: "enum",
+    Array: "array",
+    Object: "object",
+    Signature: "signature",
+};

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of the field.
+ */
+export type ExtractionFieldType = "string" | "number" | "currency" | "boolean" | "date" | "array" | "enum" | "object" | "signature";
+export declare const ExtractionFieldType: {
+    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/dist/api/types/ExtractionFieldType.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.ExtractionFieldType = void 0;
+exports.ExtractionFieldType = {
+    String: "string",
+    Number: "number",
+    Currency: "currency",
+    Boolean: "boolean",
+    Date: "date",
+    Array: "array",
+    Enum: "enum",
+    Object: "object",
+    Signature: "signature",
+};

package/dist/api/types/ExtractionOutput.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 an extraction processor
+ */
+export type ExtractionOutput = Extend.JsonOutput | Extend.FieldsArrayOutput;

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A record of edits made to the processor output.
+ */
+export interface ExtractionOutputEdits {
+    originalValue?: unknown;
+    editedValue?: unknown;
+    /** Any notes added during editing. */
+    notes?: string;
+    /** The page number where the edit was made. */
+    page?: number;
+    /** The type of the edited field. */
+    fieldType?: string;
+}

package/dist/api/types/ExtractionOutputEdits.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/FieldsArrayOutput.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 an extraction processor
+ */
+export type FieldsArrayOutput = Record<string, Extend.ExtractionFieldResult>;

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Details for figure blocks
+ */
+export interface FigureDetails {
+    /** Indicates this is a figure details object */
+    type: "figure_details";
+    /** URL to the clipped/segmented figure image. Only set if the option `figureImageClippingEnabled` in the input is `true`, which it is by default. */
+    imageUrl?: string;
+    /**
+     * The refined type of figure - only set when figure classification and summarization is enabled. Possible values:
+     *
+     * * `image`: A photographic image
+     * * `chart`: A data chart or graph
+     * * `diagram`: A schematic or diagram
+     * * `logo`: A company or brand logo
+     * * `other`: Any other type of figure
+     */
+    figureType?: Extend.FigureDetailsFigureType;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The refined type of figure - only set when figure classification and summarization is enabled. Possible values:
+ *
+ * * `image`: A photographic image
+ * * `chart`: A data chart or graph
+ * * `diagram`: A schematic or diagram
+ * * `logo`: A company or brand logo
+ * * `other`: Any other type of figure
+ */
+export type FigureDetailsFigureType = "other" | "chart" | "image" | "diagram" | "logo";
+export declare const FigureDetailsFigureType: {
+    readonly Other: "other";
+    readonly Chart: "chart";
+    readonly Image: "image";
+    readonly Diagram: "diagram";
+    readonly Logo: "logo";
+};

package/dist/api/types/FigureDetailsFigureType.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.FigureDetailsFigureType = void 0;
+exports.FigureDetailsFigureType = {
+    Other: "other",
+    Chart: "chart",
+    Image: "image",
+    Diagram: "diagram",
+    Logo: "logo",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface FileContents {
+    /** The raw text content of the file. This is included for all file types if the `rawText` query parameter is set to true in the endpoint request. */
+    rawText?: string;
+    /** Cleaned and structured markdown content of the entire file. Available for PDF and IMG file types. Only included if the `markdown` query parameter is set to true in the endpoint request. */
+    markdown?: string;
+    pages?: Extend.FileContentsPagesItem[];
+    sheets?: Extend.FileContentsSheetsItem[];
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FileContentsPagesItem {
+    /** The page number of this page in the document. */
+    pageNumber: number;
+    pageHeight?: number;
+    pageWidth?: number;
+    /** The raw text content extracted from this page. */
+    rawText?: string;
+    /** Cleaned and structured markdown content of this page. */
+    markdown?: string;
+    /** Cleaned and structured html content of the page. Available for DOCX file types (that were not auto-converted to PDFs). Only included if the `html` query parameter is set to true in the endpoint request. */
+    html?: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FileContentsSheetsItem {
+    /** The name of the sheet. */
+    sheetName: string;
+    /** The raw text content of the sheet. */
+    rawText?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface FileMetadata {
+    /** The number of pages in the file. This is only set for PDF/DOCX files. */
+    pageCount?: number;
+    /** The split metadata details. Only included if this file is a derivative of another file, for instance if it was created via a Splitter in a workflow. */
+    parentSplit?: Extend.FileMetadataParentSplit;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The split metadata details. Only included if this file is a derivative of another file, for instance if it was created via a Splitter in a workflow.
+ */
+export interface FileMetadataParentSplit {
+    /** The ID of the split. */
+    id: string;
+    /** The type of the split. */
+    type: string;
+    /** The identifier of the split. */
+    identifier: string;
+    /** The start page of the split. */
+    startPage: number;
+    /** The end page of the split. */
+    endPage: number;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of the file
+ */
+export type FileType = "PDF" | "CSV" | "IMG" | "TXT" | "DOCX" | "EXCEL" | "XML" | "HTML";
+export declare const FileType: {
+    readonly Pdf: "PDF";
+    readonly Csv: "CSV";
+    readonly Img: "IMG";
+    readonly Txt: "TXT";
+    readonly Docx: "DOCX";
+    readonly Excel: "EXCEL";
+    readonly Xml: "XML";
+    readonly Html: "HTML";
+};

package/dist/api/types/FileType.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileType = void 0;
+exports.FileType = {
+    Pdf: "PDF",
+    Csv: "CSV",
+    Img: "IMG",
+    Txt: "TXT",
+    Docx: "DOCX",
+    Excel: "EXCEL",
+    Xml: "XML",
+    Html: "HTML",
+};