bem-ai-sdk 0.7.0 → 0.8.0

package/src/resources/functions/functions.ts

@@ -85,6 +85,7 @@ export type FunctionsFunctionsPage = FunctionsPage<Function>;
 
 export type CreateFunction =
   | CreateFunction.TransformFunction
+  | CreateFunction.ExtractFunction
   | CreateFunction.AnalyzeFunction
   | CreateFunction.RouteFunction
   | CreateFunction.SendFunction
@@ -129,6 +130,41 @@ export namespace CreateFunction {
     tags?: Array<string>;
   }
 
+  export interface ExtractFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'extract';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName?: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled?: boolean;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+  }
+
   export interface AnalyzeFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -544,12 +580,13 @@ export interface EnrichStep {
 }
 
 /**
- * A function that delivers workflow outputs to an external destination. Send
- * functions receive the output of an upstream workflow node and forward it to a
- * webhook, S3 bucket, or Google Drive folder.
+ * A function that extracts structured JSON from documents and images. Accepts a
+ * wide range of input types including PDFs, images, spreadsheets, emails, and
+ * more.
  */
 export type Function =
   | Function.TransformFunction
+  | Function.ExtractFunction
   | Function.AnalyzeFunction
   | Function.RouteFunction
   | Function.SendFunction
@@ -620,6 +657,66 @@ export namespace Function {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  /**
+   * A function that extracts structured JSON from documents and images. Accepts a
+   * wide range of input types including PDFs, images, spreadsheets, emails, and
+   * more.
+   */
+  export interface ExtractFunction {
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled: boolean;
+
+    type: 'extract';
+
+    /**
+     * Version number of function.
+     */
+    versionNum: number;
+
+    /**
+     * Audit trail information for the function.
+     */
+    audit?: FunctionsAPI.FunctionAudit;
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+  }
+
   export interface AnalyzeFunction {
     /**
      * Unique identifier of function.
@@ -1076,9 +1173,9 @@ export interface FunctionAudit {
  */
 export interface FunctionResponse {
   /**
-   * A function that delivers workflow outputs to an external destination. Send
-   * functions receive the output of an upstream workflow node and forward it to a
-   * webhook, S3 bucket, or Google Drive folder.
+   * A function that extracts structured JSON from documents and images. Accepts a
+   * wide range of input types including PDFs, images, spreadsheets, emails, and
+   * more.
    */
   function: Function;
 }
@@ -1088,6 +1185,7 @@ export interface FunctionResponse {
  */
 export type FunctionType =
   | 'transform'
+  | 'extract'
   | 'route'
   | 'send'
   | 'split'
@@ -1161,6 +1259,7 @@ export interface SplitFunctionSemanticPageItemClass {
  */
 export type UpdateFunction =
   | UpdateFunction.TransformFunction
+  | UpdateFunction.ExtractFunction
   | UpdateFunction.AnalyzeFunction
   | UpdateFunction.RouteFunction
   | UpdateFunction.SendFunction
@@ -1205,6 +1304,41 @@ export namespace UpdateFunction {
     tags?: Array<string>;
   }
 
+  export interface ExtractFunction {
+    type: 'extract';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName?: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName?: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled?: boolean;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+  }
+
   export interface AnalyzeFunction {
     type: 'analyze';
 
@@ -1518,6 +1652,7 @@ export interface WorkflowUsageInfo {
 
 export type FunctionCreateParams =
   | FunctionCreateParams.CreateTransformFunction
+  | FunctionCreateParams.CreateExtractFunction
   | FunctionCreateParams.CreateAnalyzeFunction
   | FunctionCreateParams.CreateRouteFunction
   | FunctionCreateParams.CreateSendFunction
@@ -1562,6 +1697,41 @@ export declare namespace FunctionCreateParams {
     tags?: Array<string>;
   }
 
+  export interface CreateExtractFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'extract';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName?: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled?: boolean;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+  }
+
   export interface CreateAnalyzeFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -1828,6 +1998,7 @@ export declare namespace FunctionCreateParams {
 
 export type FunctionUpdateParams =
   | FunctionUpdateParams.UpsertTransformFunction
+  | FunctionUpdateParams.UpsertExtractFunction
   | FunctionUpdateParams.UpsertAnalyzeFunction
   | FunctionUpdateParams.UpsertRouteFunction
   | FunctionUpdateParams.UpsertSendFunction
@@ -1872,6 +2043,41 @@ export declare namespace FunctionUpdateParams {
     tags?: Array<string>;
   }
 
+  export interface UpsertExtractFunction {
+    type: 'extract';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName?: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema?: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName?: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled?: boolean;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+  }
+
   export interface UpsertAnalyzeFunction {
     type: 'analyze';
 

package/src/resources/functions/versions.ts

@@ -49,6 +49,7 @@ export class Versions extends APIResource {
  */
 export type FunctionVersion =
   | FunctionVersion.TransformFunctionVersion
+  | FunctionVersion.ExtractFunctionVersion
   | FunctionVersion.AnalyzeFunctionVersion
   | FunctionVersion.RouteFunctionVersion
   | FunctionVersion.SendFunctionVersion
@@ -124,6 +125,66 @@ export namespace FunctionVersion {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  export interface ExtractFunctionVersion {
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    /**
+     * Desired output structure defined in standard JSON Schema convention.
+     */
+    outputSchema: unknown;
+
+    /**
+     * Name of output schema object.
+     */
+    outputSchemaName: string;
+
+    /**
+     * Whether tabular chunking is enabled. When true, tables in CSV/Excel files are
+     * processed in row batches rather than all at once.
+     */
+    tabularChunkingEnabled: boolean;
+
+    type: 'extract';
+
+    /**
+     * Version number of function.
+     */
+    versionNum: number;
+
+    /**
+     * Audit trail information for the function version.
+     */
+    audit?: FunctionsAPI.FunctionAudit;
+
+    /**
+     * The date and time the function version was created.
+     */
+    createdAt?: string;
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+  }
+
   export interface AnalyzeFunctionVersion {
     /**
      * Unique identifier of function.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.7.0'; // x-release-please-version
+exports.VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map