bem-ai-sdk 0.2.0 → 0.4.0

package/src/resources/functions/functions.ts

@@ -87,6 +87,7 @@ export type CreateFunction =
   | CreateFunction.TransformFunction
   | CreateFunction.AnalyzeFunction
   | CreateFunction.RouteFunction
+  | CreateFunction.SendFunction
   | CreateFunction.SplitFunction
   | CreateFunction.JoinFunction
   | CreateFunction.PayloadShapingFunction
@@ -187,6 +188,56 @@ export namespace CreateFunction {
     tags?: Array<string>;
   }
 
+  export interface SendFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -491,15 +542,15 @@ export interface EnrichStep {
 }
 
 /**
- * A function that transforms and customizes input payloads using JMESPath
- * expressions. Payload shaping allows you to extract specific data, perform
- * calculations, and reshape complex input structures into simplified, standardized
- * output formats tailored to your downstream systems or business requirements.
+ * 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.
  */
 export type Function =
   | Function.TransformFunction
   | Function.AnalyzeFunction
   | Function.RouteFunction
+  | Function.SendFunction
   | Function.SplitFunction
   | Function.JoinFunction
   | Function.PayloadShapingFunction
@@ -672,6 +723,81 @@ export namespace Function {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  /**
+   * 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.
+   */
+  export interface SendFunction {
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * 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;
+
+    /**
+     * Google Drive folder ID. Present when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Present when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * S3 key prefix (folder path). Optional, present when destinationType is s3.
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+
+    /**
+     * Whether webhook payloads are signed with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Present when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     /**
      * Unique identifier of function.
@@ -948,10 +1074,9 @@ export interface FunctionAudit {
  */
 export interface FunctionResponse {
   /**
-   * A function that transforms and customizes input payloads using JMESPath
-   * expressions. Payload shaping allows you to extract specific data, perform
-   * calculations, and reshape complex input structures into simplified, standardized
-   * output formats tailored to your downstream systems or business requirements.
+   * 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.
    */
   function: Function;
 }
@@ -962,6 +1087,7 @@ export interface FunctionResponse {
 export type FunctionType =
   | 'transform'
   | 'route'
+  | 'send'
   | 'split'
   | 'join'
   | 'analyze'
@@ -1035,6 +1161,7 @@ export type UpdateFunction =
   | UpdateFunction.TransformFunction
   | UpdateFunction.AnalyzeFunction
   | UpdateFunction.RouteFunction
+  | UpdateFunction.SendFunction
   | UpdateFunction.SplitFunction
   | UpdateFunction.JoinFunction
   | UpdateFunction.PayloadShapingFunction
@@ -1135,6 +1262,56 @@ export namespace UpdateFunction {
     tags?: Array<string>;
   }
 
+  export interface SendFunction {
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * 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;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     type: 'split';
 
@@ -1339,6 +1516,7 @@ export type FunctionCreateParams =
   | FunctionCreateParams.CreateTransformFunction
   | FunctionCreateParams.CreateAnalyzeFunction
   | FunctionCreateParams.CreateRouteFunction
+  | FunctionCreateParams.CreateSendFunction
   | FunctionCreateParams.CreateSplitFunction
   | FunctionCreateParams.CreateJoinFunction
   | FunctionCreateParams.CreatePayloadShapingFunction
@@ -1439,6 +1617,56 @@ export declare namespace FunctionCreateParams {
     tags?: Array<string>;
   }
 
+  export interface CreateSendFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface CreateSplitFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -1596,6 +1824,7 @@ export type FunctionUpdateParams =
   | FunctionUpdateParams.UpsertTransformFunction
   | FunctionUpdateParams.UpsertAnalyzeFunction
   | FunctionUpdateParams.UpsertRouteFunction
+  | FunctionUpdateParams.UpsertSendFunction
   | FunctionUpdateParams.UpsertSplitFunction
   | FunctionUpdateParams.UpsertJoinFunction
   | FunctionUpdateParams.UpsertPayloadShapingFunction
@@ -1696,6 +1925,56 @@ export declare namespace FunctionUpdateParams {
     tags?: Array<string>;
   }
 
+  export interface UpsertSendFunction {
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * 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;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface UpsertSplitFunction {
     type: 'split';
 

package/src/resources/functions/versions.ts

@@ -51,6 +51,7 @@ export type FunctionVersion =
   | FunctionVersion.TransformFunctionVersion
   | FunctionVersion.AnalyzeFunctionVersion
   | FunctionVersion.RouteFunctionVersion
+  | FunctionVersion.SendFunctionVersion
   | FunctionVersion.SplitFunctionVersion
   | FunctionVersion.JoinFunctionVersion
   | FunctionVersion.EnrichFunctionVersion
@@ -238,6 +239,65 @@ export namespace FunctionVersion {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  export interface SendFunctionVersion {
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * 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;
+
+    googleDriveFolderId?: string;
+
+    s3Bucket?: string;
+
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+
+    webhookSigningEnabled?: boolean;
+
+    webhookUrl?: string;
+  }
+
   export interface SplitFunctionVersion {
     /**
      * Unique identifier of function.

package/src/resources/index.ts

@@ -29,6 +29,7 @@ export {
   type FunctionListParams,
   type FunctionsFunctionsPage,
 } from './functions/functions';
+export { InferSchema, type InferSchemaCreateResponse, type InferSchemaCreateParams } from './infer-schema';
 export {
   Outputs,
   type AnyType,

package/src/resources/infer-schema.ts

@@ -0,0 +1,160 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+
+/**
+ * Infer JSON Schemas from uploaded documents using AI.
+ *
+ * Upload a file (PDF, image, spreadsheet, email, etc.) and receive a general-purpose JSON Schema
+ * that captures the document's structure. The inferred schema can be used directly as the
+ * `outputSchema` when creating Transform functions.
+ *
+ * The schema is designed to be broadly applicable to documents of the same type, not just
+ * the specific file uploaded.
+ */
+export class InferSchema extends APIResource {
+  /**
+   * **Analyze a file and infer a JSON Schema from its contents.**
+   *
+   * Accepts a file via multipart form upload and uses Gemini to analyze the
+   * document, returning a description of its contents, an inferred JSON Schema
+   * capturing all extractable fields, and document classification metadata.
+   *
+   * The returned schema is designed to be reusable across many similar documents of
+   * the same type, not just the specific file uploaded. It can be used directly as
+   * the `outputSchema` when creating a Transform function.
+   *
+   * The endpoint also detects whether the file contains multiple bundled documents
+   * and classifies the content nature (textual, visual, audio, video, or mixed).
+   *
+   * ## Supported file types
+   *
+   * PDF, PNG, JPEG, HEIC, HEIF, WebP, CSV, XLS, XLSX, DOCX, JSON, HTML, XML, EML,
+   * plain text, WAV, MP3, M4A, MP4.
+   *
+   * ## File size limit
+   *
+   * Maximum file size is **20 MB**.
+   *
+   * ## Example
+   *
+   * ```bash
+   * curl -X POST https://api.bem.ai/v3/infer-schema \
+   *   -H "x-api-key: YOUR_API_KEY" \
+   *   -F "file=@invoice.pdf"
+   * ```
+   */
+  create(body: InferSchemaCreateParams, options?: RequestOptions): APIPromise<InferSchemaCreateResponse> {
+    return this._client.post(
+      '/v3/infer-schema',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+/**
+ * Response from the infer-schema endpoint.
+ */
+export interface InferSchemaCreateResponse {
+  /**
+   * Analysis result returned by the infer-schema endpoint.
+   */
+  analysis: InferSchemaCreateResponse.Analysis;
+
+  /**
+   * Original filename of the uploaded file.
+   */
+  filename: string;
+}
+
+export namespace InferSchemaCreateResponse {
+  /**
+   * Analysis result returned by the infer-schema endpoint.
+   */
+  export interface Analysis {
+    /**
+     * Classification of the primary content. One of: `textual`, `visual`, `audio`,
+     * `video`, `mixed`.
+     */
+    contentNature: string;
+
+    /**
+     * MIME content type of the uploaded file.
+     */
+    contentType: string;
+
+    /**
+     * 2-3 sentence description of what the file contains.
+     */
+    description: string;
+
+    /**
+     * List of distinct document types found in the file with counts.
+     */
+    documentTypes: Array<Analysis.DocumentType>;
+
+    /**
+     * Original filename of the uploaded file.
+     */
+    fileName: string;
+
+    /**
+     * High-level file category (e.g. "document", "image", "spreadsheet", "email").
+     */
+    fileType: string;
+
+    /**
+     * Whether the file contains multiple separate documents bundled together.
+     */
+    isMultiDocument: boolean;
+
+    /**
+     * Size of the uploaded file in bytes.
+     */
+    sizeBytes: number;
+
+    /**
+     * Inferred JSON Schema representing all extractable data fields.
+     */
+    schema?: unknown;
+  }
+
+  export namespace Analysis {
+    /**
+     * Describes a distinct document type found in the file.
+     */
+    export interface DocumentType {
+      /**
+       * Number of instances of this document type in the file.
+       */
+      count: number;
+
+      /**
+       * Brief description of this document type.
+       */
+      description: string;
+
+      /**
+       * Short snake_case name (e.g. "invoice", "receipt", "utility_bill").
+       */
+      name: string;
+    }
+  }
+}
+
+export interface InferSchemaCreateParams {
+  /**
+   * The file to analyze and infer a JSON schema from.
+   */
+  file: unknown;
+}
+
+export declare namespace InferSchema {
+  export {
+    type InferSchemaCreateResponse as InferSchemaCreateResponse,
+    type InferSchemaCreateParams as InferSchemaCreateParams,
+  };
+}