@anyformat/sdk 0.2.0 → 0.2.2

package/dist/index.d.cts

@@ -627,6 +627,10 @@ type Evidence = {
  * ExtractNode
  */
 type ExtractNode = {
+    /**
+     * Context Tracker
+     */
+    context_tracker?: string;
     /**
      * Schema for the fields this node extracts. Required. The backend executor populates this from the ORM field tree before constructing the typed node; nothing else should be able to build an ExtractNode without it.
      */
@@ -682,7 +686,15 @@ type ExtractNode = {
     /**
      * Mode
      */
-    mode?: 'standard' | 'agentic';
+    mode?: 'standard' | 'agentic' | 'max';
+    /**
+     * Page Sum Verification Enabled
+     */
+    page_sum_verification_enabled?: boolean;
+    /**
+     * Row Extractor Enabled
+     */
+    row_extractor_enabled?: boolean;
     /**
      * Type
      */
@@ -972,6 +984,8 @@ type ObjectField = {
     name: string;
     /**
      * Nested Fields
+     *
+     * Child fields of this object. Only one level of nesting is supported — an object field's children must be non-object types.
      */
     nested_fields: Array<({
         data_type: 'string';
@@ -989,14 +1003,16 @@ type ObjectField = {
         data_type: 'enum';
     } & EnumField) | ({
         data_type: 'multi_select';
-    } & MultiSelectField) | ({
-        data_type: 'object';
-    } & ObjectField)>;
+    } & MultiSelectField)>;
 };
 /**
  * ParseNode
  */
 type ParseNode = {
+    /**
+     * Cache
+     */
+    cache?: boolean;
     /**
      * Figure Enhancement
      */
@@ -1325,12 +1341,45 @@ type WorkflowCreateRequest = {
     } & ValidateNode)>;
 };
 
+/**
+ * Typed view over the parse node's output. Returned by `Result.parse` — readers
+ * use it for `.markdown`, `.text`, `.blocks`, `.parseConfidence`, and
+ * `.layoutConfidence` without having to walk `result.raw.parse`.
+ *
+ * No `.draw()` here: rasterising pages requires PDF rendering (pdfium); the
+ * Python SDK ships that, the TS SDK does not.
+ */
+declare class ParseView {
+    private readonly parse;
+    /** @internal */
+    constructor(parse: ParseResult);
+    get markdown(): string | null;
+    get text(): string | null;
+    get blocks(): Block[];
+    /**
+     * Document-level confidence (0-100) in the parsed content. May be `null` for
+     * some parse modes — fall back to `layoutConfidence`.
+     */
+    get parseConfidence(): number | null;
+    /**
+     * Document-level confidence (0-100) in the page layout (block positions).
+     * `null` when not available.
+     */
+    get layoutConfidence(): number | null;
+}
+
 /** Typed wrapper over a completed run's results. */
 declare class Result {
     readonly raw: ResultsResponse;
+    private _parse;
     constructor(raw: ResultsResponse);
     get collectionId(): string;
     get extractions(): Extraction[];
+    /**
+     * Typed view over the parse node's output, or `null` when the workflow has
+     * no parse node. Cached so repeated access doesn't re-wrap.
+     */
+    get parse(): ParseView | null;
     /**
      * Convenience accessor for a top-level scalar field on the first
      * extraction (linear workflows). Returns `undefined` for missing fields
@@ -1340,34 +1389,49 @@ declare class Result {
 }
 
 interface WaitOptions {
-    /** Overall budget before giving up. Default 120s. */
+    /** Overall budget before giving up. Default 300 000 ms (300s). */
     timeoutMs?: number;
-    /** Delay between result polls. Default 2s. */
+    /** Delay between result polls. Default 3 000 ms (3s). */
     pollMs?: number;
 }
 /**
- * A pending run. Lazily creates the workflow, submits the document, and
- * polls for results when `wait()` is awaited.
+ * A submitted run. `wait()` polls for completion. Created eagerly by
+ * `Workflow.run()` — the workflow + file submission have already happened
+ * by the time you hold a `Run`.
  */
 declare class Run {
     private readonly client;
-    private readonly request;
-    private readonly file;
-    private readonly text;
-    private workflowId;
-    private collectionId;
-    constructor(client: Client, request: WorkflowCreateRequest, file: Blob | File | null, text: string | null);
-    /**
-     * Create the workflow and submit the document — exactly once per `Run`.
-     * Memoized so that retrying `wait()` after an `SDKTimeout` resumes polling
-     * the in-flight run instead of creating a duplicate workflow + submission.
-     */
-    private submit;
+    readonly workflowId: string;
+    readonly id: string;
+    /** @internal */
+    constructor(client: Client, workflowId: string, id: string);
     wait(opts?: WaitOptions): Promise<Result>;
 }
 
+/**
+ * A persisted workflow on the server. Returned by `WorkflowBuilder.create()`.
+ * `run(file | text)` submits a document against this workflow's id and returns
+ * a `Run` you can `.wait()` on for results.
+ */
+declare class Workflow {
+    private readonly client;
+    readonly id: string;
+    readonly name: string;
+    /** @internal */
+    constructor(client: Client, id: string, name: string);
+    /** Submit a document against this workflow and return a pending `Run`. */
+    run(file?: File | null, opts?: {
+        text?: string;
+    }): Promise<Run>;
+}
+
 /** Any extraction field — the discriminated union on `data_type`. */
 type Field = ExtractionSchema["fields"][number];
+/**
+ * A field that may appear inside an object. Excludes `object`: only one
+ * level of nesting is supported, so objects cannot contain objects.
+ */
+type NestedField = ObjectField["nested_fields"][number];
 type LookupOpt = {
     lookup?: boolean;
 };
@@ -1385,7 +1449,7 @@ declare const Schema: {
     datetime: (name: string, description: string, opts?: LookupOpt) => DatetimeField;
     enum: (name: string, description: string, options: EnumOption[], opts?: LookupOpt) => EnumField;
     multiSelect: (name: string, description: string, options: EnumOption[], opts?: LookupOpt) => MultiSelectField;
-    object: (name: string, description: string, fields: Field[], opts?: LookupOpt) => ObjectField;
+    object: (name: string, description: string, fields: NestedField[], opts?: LookupOpt) => ObjectField;
     option: (name: string, description: string) => EnumOption;
 };
 
@@ -1396,13 +1460,15 @@ interface ParseOptions {
     mode?: ParseMode;
     promptHint?: string;
     figureEnhancement?: boolean;
+    cache?: boolean;
     id?: string;
 }
 /**
  * Fluent assembler for a typed workflow graph — a faithful TS port of the
  * Python `WorkflowBuilder`. `parse`/`classify`/`split` are singletons;
  * `extract`/`validate` are repeatable and carry their edge metadata. Call
- * `build()` (or `create()`/`run()`) to emit the wire request.
+ * `build()` (or `create()`) to emit the wire request — submit with
+ * `Workflow.run(file)` on the handle that `create()` returns.
  */
 declare class WorkflowBuilder {
     private readonly client;
@@ -1440,12 +1506,10 @@ declare class WorkflowBuilder {
     private normalizeExtractBranch;
     /** Assemble the wire request (branch-routed edges). Pure — no network. */
     build(): WorkflowCreateRequest;
-    /** Persist the workflow and return its id. */
-    create(): Promise<string>;
-    /** Create the workflow, submit a document, and return a pending `Run`. */
-    run(file?: Blob | File | null, opts?: {
-        text?: string;
-    }): Run;
+    /** Persist the workflow and return a handle you can `.run(file)` on. */
+    create(): Promise<Workflow>;
+    /** Replace an existing workflow's definition and return a handle you can `.run(file)` on. */
+    update(workflowId: string): Promise<Workflow>;
 }
 
 interface AnyformatOptions {
@@ -1459,6 +1523,12 @@ declare class Anyformat {
     readonly _client: Client;
     constructor(opts: AnyformatOptions);
     workflow(name: string, description?: string): WorkflowBuilder;
+    listWorkflows(opts?: {
+        page?: number;
+        pageSize?: number;
+        status?: string;
+    }): Promise<Workflow[]>;
+    deleteWorkflow(workflowId: string): Promise<string>;
 }
 
 declare class AnyformatError extends Error {
@@ -1486,4 +1556,4 @@ declare class SDKTimeout extends AnyformatError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, Anyformat, AnyformatError, type AnyformatOptions, BadRequest, type BooleanField, type Branch, type ClassifyCategory, type DateField, type DatetimeField, type EnumField, type EnumOption, type ExtractedField, type Extraction, type ExtractionSchema, type Field, type FloatField, Forbidden, type IntegerField, type MultiSelectField, NotFound, type ObjectField, RateLimited, Result, type ResultsResponse, Run, SDKTimeout, Schema, ServerError, type SplitterRule, type StringField, Unauthorized, type ValidationRule, type WaitOptions, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest };
+export { APIError, Anyformat, AnyformatError, type AnyformatOptions, BadRequest, type Block, type BooleanField, type Branch, type ClassifyCategory, type DateField, type DatetimeField, type EnumField, type EnumOption, type ExtractedField, type Extraction, type ExtractionSchema, type Field, type FloatField, Forbidden, type IntegerField, type MultiSelectField, type NestedField, NotFound, type ObjectField, ParseView, RateLimited, Result, type ResultsResponse, Run, SDKTimeout, Schema, ServerError, type SplitterRule, type StringField, Unauthorized, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest };

package/dist/index.d.ts

@@ -627,6 +627,10 @@ type Evidence = {
  * ExtractNode
  */
 type ExtractNode = {
+    /**
+     * Context Tracker
+     */
+    context_tracker?: string;
     /**
      * Schema for the fields this node extracts. Required. The backend executor populates this from the ORM field tree before constructing the typed node; nothing else should be able to build an ExtractNode without it.
      */
@@ -682,7 +686,15 @@ type ExtractNode = {
     /**
      * Mode
      */
-    mode?: 'standard' | 'agentic';
+    mode?: 'standard' | 'agentic' | 'max';
+    /**
+     * Page Sum Verification Enabled
+     */
+    page_sum_verification_enabled?: boolean;
+    /**
+     * Row Extractor Enabled
+     */
+    row_extractor_enabled?: boolean;
     /**
      * Type
      */
@@ -972,6 +984,8 @@ type ObjectField = {
     name: string;
     /**
      * Nested Fields
+     *
+     * Child fields of this object. Only one level of nesting is supported — an object field's children must be non-object types.
      */
     nested_fields: Array<({
         data_type: 'string';
@@ -989,14 +1003,16 @@ type ObjectField = {
         data_type: 'enum';
     } & EnumField) | ({
         data_type: 'multi_select';
-    } & MultiSelectField) | ({
-        data_type: 'object';
-    } & ObjectField)>;
+    } & MultiSelectField)>;
 };
 /**
  * ParseNode
  */
 type ParseNode = {
+    /**
+     * Cache
+     */
+    cache?: boolean;
     /**
      * Figure Enhancement
      */
@@ -1325,12 +1341,45 @@ type WorkflowCreateRequest = {
     } & ValidateNode)>;
 };
 
+/**
+ * Typed view over the parse node's output. Returned by `Result.parse` — readers
+ * use it for `.markdown`, `.text`, `.blocks`, `.parseConfidence`, and
+ * `.layoutConfidence` without having to walk `result.raw.parse`.
+ *
+ * No `.draw()` here: rasterising pages requires PDF rendering (pdfium); the
+ * Python SDK ships that, the TS SDK does not.
+ */
+declare class ParseView {
+    private readonly parse;
+    /** @internal */
+    constructor(parse: ParseResult);
+    get markdown(): string | null;
+    get text(): string | null;
+    get blocks(): Block[];
+    /**
+     * Document-level confidence (0-100) in the parsed content. May be `null` for
+     * some parse modes — fall back to `layoutConfidence`.
+     */
+    get parseConfidence(): number | null;
+    /**
+     * Document-level confidence (0-100) in the page layout (block positions).
+     * `null` when not available.
+     */
+    get layoutConfidence(): number | null;
+}
+
 /** Typed wrapper over a completed run's results. */
 declare class Result {
     readonly raw: ResultsResponse;
+    private _parse;
     constructor(raw: ResultsResponse);
     get collectionId(): string;
     get extractions(): Extraction[];
+    /**
+     * Typed view over the parse node's output, or `null` when the workflow has
+     * no parse node. Cached so repeated access doesn't re-wrap.
+     */
+    get parse(): ParseView | null;
     /**
      * Convenience accessor for a top-level scalar field on the first
      * extraction (linear workflows). Returns `undefined` for missing fields
@@ -1340,34 +1389,49 @@ declare class Result {
 }
 
 interface WaitOptions {
-    /** Overall budget before giving up. Default 120s. */
+    /** Overall budget before giving up. Default 300 000 ms (300s). */
     timeoutMs?: number;
-    /** Delay between result polls. Default 2s. */
+    /** Delay between result polls. Default 3 000 ms (3s). */
     pollMs?: number;
 }
 /**
- * A pending run. Lazily creates the workflow, submits the document, and
- * polls for results when `wait()` is awaited.
+ * A submitted run. `wait()` polls for completion. Created eagerly by
+ * `Workflow.run()` — the workflow + file submission have already happened
+ * by the time you hold a `Run`.
  */
 declare class Run {
     private readonly client;
-    private readonly request;
-    private readonly file;
-    private readonly text;
-    private workflowId;
-    private collectionId;
-    constructor(client: Client, request: WorkflowCreateRequest, file: Blob | File | null, text: string | null);
-    /**
-     * Create the workflow and submit the document — exactly once per `Run`.
-     * Memoized so that retrying `wait()` after an `SDKTimeout` resumes polling
-     * the in-flight run instead of creating a duplicate workflow + submission.
-     */
-    private submit;
+    readonly workflowId: string;
+    readonly id: string;
+    /** @internal */
+    constructor(client: Client, workflowId: string, id: string);
     wait(opts?: WaitOptions): Promise<Result>;
 }
 
+/**
+ * A persisted workflow on the server. Returned by `WorkflowBuilder.create()`.
+ * `run(file | text)` submits a document against this workflow's id and returns
+ * a `Run` you can `.wait()` on for results.
+ */
+declare class Workflow {
+    private readonly client;
+    readonly id: string;
+    readonly name: string;
+    /** @internal */
+    constructor(client: Client, id: string, name: string);
+    /** Submit a document against this workflow and return a pending `Run`. */
+    run(file?: File | null, opts?: {
+        text?: string;
+    }): Promise<Run>;
+}
+
 /** Any extraction field — the discriminated union on `data_type`. */
 type Field = ExtractionSchema["fields"][number];
+/**
+ * A field that may appear inside an object. Excludes `object`: only one
+ * level of nesting is supported, so objects cannot contain objects.
+ */
+type NestedField = ObjectField["nested_fields"][number];
 type LookupOpt = {
     lookup?: boolean;
 };
@@ -1385,7 +1449,7 @@ declare const Schema: {
     datetime: (name: string, description: string, opts?: LookupOpt) => DatetimeField;
     enum: (name: string, description: string, options: EnumOption[], opts?: LookupOpt) => EnumField;
     multiSelect: (name: string, description: string, options: EnumOption[], opts?: LookupOpt) => MultiSelectField;
-    object: (name: string, description: string, fields: Field[], opts?: LookupOpt) => ObjectField;
+    object: (name: string, description: string, fields: NestedField[], opts?: LookupOpt) => ObjectField;
     option: (name: string, description: string) => EnumOption;
 };
 
@@ -1396,13 +1460,15 @@ interface ParseOptions {
     mode?: ParseMode;
     promptHint?: string;
     figureEnhancement?: boolean;
+    cache?: boolean;
     id?: string;
 }
 /**
  * Fluent assembler for a typed workflow graph — a faithful TS port of the
  * Python `WorkflowBuilder`. `parse`/`classify`/`split` are singletons;
  * `extract`/`validate` are repeatable and carry their edge metadata. Call
- * `build()` (or `create()`/`run()`) to emit the wire request.
+ * `build()` (or `create()`) to emit the wire request — submit with
+ * `Workflow.run(file)` on the handle that `create()` returns.
  */
 declare class WorkflowBuilder {
     private readonly client;
@@ -1440,12 +1506,10 @@ declare class WorkflowBuilder {
     private normalizeExtractBranch;
     /** Assemble the wire request (branch-routed edges). Pure — no network. */
     build(): WorkflowCreateRequest;
-    /** Persist the workflow and return its id. */
-    create(): Promise<string>;
-    /** Create the workflow, submit a document, and return a pending `Run`. */
-    run(file?: Blob | File | null, opts?: {
-        text?: string;
-    }): Run;
+    /** Persist the workflow and return a handle you can `.run(file)` on. */
+    create(): Promise<Workflow>;
+    /** Replace an existing workflow's definition and return a handle you can `.run(file)` on. */
+    update(workflowId: string): Promise<Workflow>;
 }
 
 interface AnyformatOptions {
@@ -1459,6 +1523,12 @@ declare class Anyformat {
     readonly _client: Client;
     constructor(opts: AnyformatOptions);
     workflow(name: string, description?: string): WorkflowBuilder;
+    listWorkflows(opts?: {
+        page?: number;
+        pageSize?: number;
+        status?: string;
+    }): Promise<Workflow[]>;
+    deleteWorkflow(workflowId: string): Promise<string>;
 }
 
 declare class AnyformatError extends Error {
@@ -1486,4 +1556,4 @@ declare class SDKTimeout extends AnyformatError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, Anyformat, AnyformatError, type AnyformatOptions, BadRequest, type BooleanField, type Branch, type ClassifyCategory, type DateField, type DatetimeField, type EnumField, type EnumOption, type ExtractedField, type Extraction, type ExtractionSchema, type Field, type FloatField, Forbidden, type IntegerField, type MultiSelectField, NotFound, type ObjectField, RateLimited, Result, type ResultsResponse, Run, SDKTimeout, Schema, ServerError, type SplitterRule, type StringField, Unauthorized, type ValidationRule, type WaitOptions, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest };
+export { APIError, Anyformat, AnyformatError, type AnyformatOptions, BadRequest, type Block, type BooleanField, type Branch, type ClassifyCategory, type DateField, type DatetimeField, type EnumField, type EnumOption, type ExtractedField, type Extraction, type ExtractionSchema, type Field, type FloatField, Forbidden, type IntegerField, type MultiSelectField, type NestedField, NotFound, type ObjectField, ParseView, RateLimited, Result, type ResultsResponse, Run, SDKTimeout, Schema, ServerError, type SplitterRule, type StringField, Unauthorized, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest };