extend-ai 0.0.1-beta

package/api/types/Block.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface Block {
+    /** The type of object. In this case, it will always be `"block"`. */
+    object: string;
+    /** A unique identifier for the block, deterministically generated as a hash of the block content. */
+    id: string;
+    /**
+     * The type of block:
+     * * `"text"` - Regular text content
+     * * `"heading"` - Section or document headings
+     * * `"section_heading"` - Subsection headings
+     * * `"table"` - Tabular data with rows and columns
+     * * `"table_head"` - Table header cells
+     * * `"table_cell"` - Table body cells
+     * * `"figure"` - Images, charts, diagrams, or logos
+     */
+    type: Extend.BlockType;
+    /** The textual content of the block formatted based on the target format. */
+    content: string;
+    /** Additional details specific to the block type. The schema depends on the block type. */
+    details: Extend.BlockDetails;
+    /** Metadata about the block. */
+    metadata: Extend.BlockMetadata;
+    /** An array of points defining the polygon that bounds the block. */
+    polygon: Extend.BlockPolygonItem[];
+    /** A simplified bounding box for the block. */
+    boundingBox: Extend.BlockBoundingBox;
+}

package/api/types/Block.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/BlockBoundingBox.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A simplified bounding box for the block.
+ */
+export interface BlockBoundingBox {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+}

package/api/types/BlockBoundingBox.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/BlockDetails.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Additional details specific to the block type. The schema depends on the block type.
+ */
+export type BlockDetails = Extend.TableDetails | Extend.TableCellDetails | Extend.FigureDetails | Extend.EmptyBlockDetails;

package/api/types/BlockDetails.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/BlockMetadata.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Metadata about the block.
+ */
+export interface BlockMetadata {
+    /** Information about the page this block appears on. */
+    page?: Extend.BlockMetadataPage;
+}

package/api/types/BlockMetadata.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/BlockMetadataPage.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Information about the page this block appears on.
+ */
+export interface BlockMetadataPage {
+    /** The page number where this block appears. */
+    number: number;
+    /** The width of the page in points. */
+    width?: number;
+    /** The height of the page in points. */
+    height?: number;
+}

package/api/types/BlockMetadataPage.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/BlockPolygonItem.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BlockPolygonItem {
+    x: number;
+    y: number;
+}

package/api/types/BlockPolygonItem.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/BlockType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of block:
+ * * `"text"` - Regular text content
+ * * `"heading"` - Section or document headings
+ * * `"section_heading"` - Subsection headings
+ * * `"table"` - Tabular data with rows and columns
+ * * `"table_head"` - Table header cells
+ * * `"table_cell"` - Table body cells
+ * * `"figure"` - Images, charts, diagrams, or logos
+ */
+export type BlockType = "text" | "heading" | "section_heading" | "table" | "figure";
+export declare const BlockType: {
+    readonly Text: "text";
+    readonly Heading: "heading";
+    readonly SectionHeading: "section_heading";
+    readonly Table: "table";
+    readonly Figure: "figure";
+};

package/api/types/BlockType.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.BlockType = void 0;
+exports.BlockType = {
+    Text: "text",
+    Heading: "heading",
+    SectionHeading: "section_heading",
+    Table: "table",
+    Figure: "figure",
+};

package/api/types/Chunk.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface Chunk {
+    /** The type of object. In this case, it will always be `"chunk"`. */
+    object: string;
+    /** The type of chunk. */
+    type: Extend.ChunkType;
+    /** The parsed content of the chunk. */
+    content: string;
+    /** Metadata about the chunk. */
+    metadata: Extend.ChunkMetadata;
+    /** An array of block objects that make up the chunk. A Block represents a distinct content element within a document, such as a paragraph of text, a heading, a table, or a figure. Blocks are the fundamental units that make up chunks in parsed documents. */
+    blocks: Extend.Block[];
+}

package/api/types/Chunk.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/ChunkMetadata.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Metadata about the chunk.
+ */
+export interface ChunkMetadata {
+    /** The page range this chunk covers. Often will just be a partial page, in which cases `start` and `end` will be the same. */
+    pageRange: Extend.ChunkMetadataPageRange;
+}

package/api/types/ChunkMetadata.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/ChunkMetadataPageRange.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The page range this chunk covers. Often will just be a partial page, in which cases `start` and `end` will be the same.
+ */
+export interface ChunkMetadataPageRange {
+    /** The starting page number (inclusive). */
+    start: number;
+    /** The ending page number (inclusive). */
+    end: number;
+}

package/api/types/ChunkMetadataPageRange.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/ChunkType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of chunk.
+ */
+export type ChunkType = "page" | "document" | "section";
+export declare const ChunkType: {
+    readonly Page: "page";
+    readonly Document: "document";
+    readonly Section: "section";
+};

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

package/api/types/Citation.d.ts

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

package/api/types/Citation.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/Classification.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Classification {
+    /** Unique identifier for the classification. We recommend lowercase, underscore-separated format. */
+    id: string;
+    /** Type identifier for the classification. */
+    type: string;
+    /** A detailed description of the classification. */
+    description: string;
+}

package/api/types/Classification.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/ClassificationAdvancedOptions.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ClassificationAdvancedOptions {
+    /** The context to use for classification. */
+    context?: Extend.ClassificationAdvancedOptionsContext;
+    /** Enable advanced multimodal processing for better handling of visual elements during classification. */
+    advancedMultimodalEnabled?: boolean;
+    /** Limit processing to a specific number of pages from the beginning of the document. */
+    fixedPageLimit?: number;
+}

package/api/types/ClassificationAdvancedOptions.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/ClassificationAdvancedOptionsContext.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The context to use for classification.
+ */
+export type ClassificationAdvancedOptionsContext = "default" | "max";
+export declare const ClassificationAdvancedOptionsContext: {
+    readonly Default: "default";
+    readonly Max: "max";
+};

package/api/types/ClassificationAdvancedOptionsContext.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.ClassificationAdvancedOptionsContext = void 0;
+exports.ClassificationAdvancedOptionsContext = {
+    Default: "default",
+    Max: "max",
+};

package/api/types/ClassificationConfig.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ClassificationConfig {
+    /** The base processor to use. For classifiers, this must be either `"classifier_performance"` or `"classifier_light"`. See the [base processor documentation](https://docs.extend.ai/2025-04-21/changelog/overview) for more details. */
+    baseProcessor?: Extend.ClassificationConfigBaseProcessor;
+    /** The version of the `"classifier_performance"` or `"classifier_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;
+    /** Array of possible classifications for the document. */
+    classifications: Extend.Classification[];
+    /** Custom rules to guide the classification process in natural language. */
+    classificationRules?: string;
+    /** Advanced configuration options. */
+    advancedOptions?: Extend.ClassificationAdvancedOptions;
+}

package/api/types/ClassificationConfig.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/ClassificationConfigBaseProcessor.d.ts

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

package/api/types/ClassificationConfigBaseProcessor.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.ClassificationConfigBaseProcessor = void 0;
+exports.ClassificationConfigBaseProcessor = {
+    ClassifierPerformance: "classifier_performance",
+    ClassifierLight: "classifier_light",
+};

package/api/types/ClassifierOutput.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ClassifierOutput {
+    /** 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;
+    /** Additional insights about the classification decision */
+    insights: Extend.Insight[];
+}

package/api/types/ClassifierOutput.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/ClassifyMetrics.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * Metrics specific to classification processors
+ */
+export interface ClassifyMetrics extends Extend.BaseMetrics {
+    /** The type of metrics. Will always be `"CLASSIFY"` for classification processors. */
+    type?: "CLASSIFY";
+    /** The overall accuracy percentage. */
+    accuracyPerc?: number;
+    /** The mean confidence score. */
+    meanConfidence?: number;
+    /** Record mapping classification values to their counts. */
+    distribution?: Record<string, unknown>;
+    /** Mapping from classification to accuracy percentage as calculated from the confusion matrix. */
+    accuracyPercByClassification?: Record<string, unknown>;
+    /** Mapping from actual class to predicted class to count. Only present when accuracy percentage is present. */
+    confusionMatrix?: Record<string, unknown>;
+}

package/api/types/ClassifyMetrics.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/EmptyBlockDetails.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An empty object
+ */
+export type EmptyBlockDetails = Record<string, unknown>;

package/api/types/EmptyBlockDetails.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/Enum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Enum {
+    /** The value of the enum option. */
+    value: string;
+    /** Description of what this enum value represents. */
+    description: string;
+}

package/api/types/Enum.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/EnumOption.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface EnumOption {
+    /** The enum value (e.g. "ANNUAL", "MONTHLY", etc.) */
+    value: string;
+    /** The description of the enum value */
+    description: string;
+}

package/api/types/EnumOption.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/Error_.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Error_ {
+    success?: boolean;
+    /** Error message */
+    error?: string;
+}

package/api/types/Error_.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/EvaluationSet.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The EvaluationSet object represents an evaluation set in Extend. Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given processor in Extend.
+ */
+export interface EvaluationSet {
+    /** The type of response. In this case, it will always be `"evaluation_set"`. */
+    object: string;
+    /**
+     * The ID of the evaluation set.
+     *
+     * Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
+     */
+    id: string;
+    /**
+     * The name of the evaluation set.
+     *
+     * Example: `"Invoice Processing Test Set"`
+     */
+    name: string;
+    /**
+     * A description of the evaluation set.
+     *
+     * Example: `"Q4 2023 vendor invoices for accuracy testing"`
+     */
+    description: string;
+    /**
+     * The ID of the processor associated with this evaluation set.
+     *
+     * Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
+     */
+    processorId: string;
+    /**
+     * The time (in UTC) at which the evaluation set was created. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T15:30:00Z"`
+     */
+    createdAt: string;
+    /**
+     * The time (in UTC) at which the evaluation set was last updated. Will follow the RFC 3339 format.
+     *
+     * Example: `"2024-03-21T16:45:00Z"`
+     */
+    updatedAt: string;
+}

package/api/types/EvaluationSet.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/EvaluationSetItem.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+/**
+ * The EvaluationSetItem object represents an item in an evaluation set in Extend. Items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.
+ */
+export interface EvaluationSetItem {
+    /** The type of response. In this case, it will always be `"evaluation_set_item"`. */
+    object: string;
+    /**
+     * The ID of the evaluation set item.
+     *
+     * Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
+     */
+    id: string;
+    /**
+     * The ID of the evaluation set that this item belongs to.
+     *
+     * Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
+     */
+    evaluationSetId: string;
+    /**
+     * Extend's internal ID for the file. It will always start with "file_".
+     *
+     * Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
+     */
+    fileId: string;
+    /** The expected output that will be used to evaluate the processor's performance. This will confirm to the output type schema of the processor. */
+    expectedOutput: Extend.ProvidedProcessorOutput;
+}

package/api/types/EvaluationSetItem.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/ExtractChunkingOptions.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Extend from "../index";
+export interface ExtractChunkingOptions {
+    /** The strategy to use for chunking the document. */
+    chunkingStrategy?: Extend.ExtractChunkingOptionsChunkingStrategy;
+    /** The size of page chunks. */
+    pageChunkSize?: number;
+    /** The strategy to use for selecting chunks. */
+    chunkSelectionStrategy?: Extend.ExtractChunkingOptionsChunkSelectionStrategy;
+    /** Custom rules for semantic chunking. */
+    customSemanticChunkingRules?: string;
+}

package/api/types/ExtractChunkingOptions.js

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