@vertesia/common 0.50.0 → 0.51.0

package/src/interaction.ts

@@ -17,6 +17,7 @@ export interface InteractionExecutionError {
 export interface InteractionRef {
     id: string;
     name: string;
+    parent?: string;
     description?: string;
     status: InteractionStatus;
     visibility?: InteractionVisibility;
@@ -25,7 +26,7 @@ export interface InteractionRef {
     prompts?: PromptSegmentDef<PromptTemplateRef>[];
     updated_at: Date;
 }
-export const InteractionRefPopulate = "id name description status version visibility tags updated_at prompts";
+export const InteractionRefPopulate = "id name parent description status version visibility tags updated_at prompts";
 
 export interface InteractionRefWithSchema
     extends Omit<InteractionRef, "prompts"> {
@@ -93,7 +94,7 @@ export interface CachePolicy {
     ttl: number;
 }
 export type InteractionVisibility = 'public' | 'private';
-export interface Interaction extends ModelOptions {
+export interface Interaction {
     readonly id: string;
     name: string;
     endpoint: string;
@@ -105,9 +106,11 @@ export interface Interaction extends ModelOptions {
     version: number;
     tags: string[];
     test_data?: JSONObject;
+    interaction_schema?: JSONSchema4 | SchemaRef;
     result_schema?: JSONSchema4 | SchemaRef;
     cache_policy?: CachePolicy;
     model: string;
+    model_options?: ModelOptions;
     prompts: PromptSegmentDef[];
     output_modality?: Modalities;
     environment: string | ExecutionEnvironmentRef;
@@ -139,21 +142,9 @@ export interface InteractionUpdatePayload
         Omit<
             Interaction,
             "result_schema" | "id" | "created_at" | "updated_at" | "created_by" | "updated_by" | "project"
-            | "temperature" | "max_tokens" | "stop_sequence" | "top_k" | "top_p" | "presence_penalty" | "frequency_penalty" | "top_logprobs"
         >
     > {
     result_schema?: JSONSchema4 | null;
-
-    // Change ModelOptions properties to include null as a possible type
-    // Null values indicate that the property should be cleared.
-    temperature?: number | null;
-    max_tokens?: number | null;
-    stop_sequence?: string[] | null;
-    top_k?: number | null;
-    top_p?: number | null;
-    top_logprobs?: number | null;
-    presence_penalty?: number | null;
-    frequency_penalty?: number | null;
 }
 
 export interface InteractionPublishPayload {
@@ -276,12 +267,13 @@ export const ConfigModesOptions: Record<ConfigModes, ConfigModesDescription> = {
     [ConfigModes.INTERACTION_CONFIG_ONLY]: ConfigModesDescription.INTERACTION_CONFIG_ONLY,
 }
 
-export interface InteractionExecutionConfiguration extends ModelOptions {
+export interface InteractionExecutionConfiguration {
     environment?: string;
     model?: string;
     do_validate?: boolean;
     run_data?: RunDataStorageLevel;
     configMode?: ConfigModes;
+    model_options?: ModelOptions;
 }
 
 export interface GenerateInteractionPayload {

package/src/meters.ts

@@ -0,0 +1,24 @@
+
+
+
+
+
+export interface MeterAdjustment {
+    meter: string;
+    value: string;
+    identifier?: string;
+}
+
+
+export interface AdjustMetersMeterWorkflowParams {
+    adjustments: MeterAdjustment[];
+}
+
+export enum MeterNames {
+    analyzed_pages = 'analyzed_pages',
+    extracted_tables = 'extracted_tables',
+    analyzed_images = 'analyzed_images',
+    input_token_used = 'input_token_used',
+    output_token_used = 'output_token_used',
+    task_run = 'task_run',
+}

package/src/query.ts

@@ -69,6 +69,8 @@ export interface RunSearchQuery extends SimpleSearchQuery {
     object?: string;
     start?: string;
     end?: string;
+    finish_reason?: string;
+    created_by?: string;
 }
 
 export interface WorkflowExecutionSearchQuery extends SimpleSearchQuery {

package/src/store/activity-catalog.ts

@@ -9,7 +9,7 @@ export interface ActivityTypeDefinition {
     // in case of primitive literals will be the value
     // or nested objects / arrays will be "object" or "array"
     // for record this is Record<type,type>
-    value: string | boolean | number;
+    value: string | boolean | number | null;
     // in case of objects
     members?: ActivityPropertyDefinition[];
     // in case of arrays or promises will be innertype (i.e. the element type for arrays)

package/src/store/collections.ts

@@ -0,0 +1,62 @@
+import { BaseObject } from "./common.js";
+import { ColumnLayout, ContentObjectTypeRef } from "./store.js";
+
+export enum CollectionStatus {
+    active = 'active',
+    archived = 'archived'
+}
+
+export interface CreateCollectionPayload {
+    name: string;
+    dynamic: boolean;
+    description?: string;
+    tags?: string[];
+    type?: string;
+    query?: Record<string, any>;
+    properties?: Record<string, any>;
+    parent?: string | null;
+    table_layout?: ColumnLayout[] | null;
+}
+
+export interface CollectionItem extends BaseObject {
+    /**
+     * A flag to indicate if the collection is dynamic or static.
+     * If the collection is dynamic, the members are determined by a query using the query field.
+     * Id the collection is static, the members are explicitly defined jusing the members array.
+     */
+    dynamic: boolean;
+    status: CollectionStatus;
+    // A ref to the object type
+    type?: ContentObjectTypeRef;
+    /**
+     * The parent collection if any
+     */
+    parent?: string | null;
+    /**
+     * The table layout to use for the collection.
+     * The layout defined in the type could serve as a fallback if not defined here.
+     */
+    table_layout?: ColumnLayout[];
+}
+
+export interface Collection extends CollectionItem {
+    properties: Record<string, any>;
+    query?: Record<string, any>;
+}
+
+export interface StaticCollection extends Collection {
+    dynamic: false;
+    members: string[];
+    query: never;
+}
+
+export interface DynamicCollection extends Collection {
+    dynamic: true;
+}
+
+export interface CollectionSearchPayload {
+    dynamic?: boolean;
+    status?: CollectionStatus;
+    limit?: number;
+    offset?: number;
+}

package/src/store/doc-analyzer.ts

@@ -0,0 +1,92 @@
+import { WorkflowExecutionPayload, WorkflowExecutionStatus } from "./workflow.js";
+
+export interface PdfToRichtextOptions {
+    features: string[];
+    debug?: boolean;
+    [key: string]: any;
+}
+
+
+export interface PdfToRichTextWorkflowParams extends Omit<WorkflowExecutionPayload, "vars"> {
+    vars: PdfToRichtextOptions
+}
+
+/**
+ * Represents a image in a document that has been analyzed
+ */
+export interface DocImage {
+    id?: string;
+    page_number?: number;
+    image_number?: number;
+    title?: string;
+    url?: string;
+    description?: string;
+    is_meaningful?: boolean;
+    width?: number;
+    height?: number;
+    path?: string;
+}
+
+/**
+ * Represents a table in a document that has been analyzed
+ */
+export interface DocTable {
+    page_number?: number;
+    table_number?: number;
+    title?: string;
+    format: "application/csv" | "application/json";
+}
+
+/**
+ * Represents a table in a document that has been analyzed in CSV format
+ */
+export interface DocTableCsv extends DocTable {
+    format: "application/csv";
+    title?: string;
+    data: string;
+}
+
+/**
+ * Represents a table in a document that has been analyzed in JSON format
+ */
+export interface DocTableJson extends DocTable {
+    format: "application/json";
+    title?: string;
+    data: Object[];
+}
+
+/**
+ * Represents a document analysis run status
+ */
+export interface DocAnalyzeRunStatusResponse {
+    workflow_id: string | null;
+    run_id: string | null;
+    status: WorkflowExecutionStatus;
+    progress?: DocAnalyzerProgress;
+}
+
+
+export interface DocAnalyzerResultResponse {
+    document?: string;
+    tables?: DocTableCsv[] | DocTableJson[];
+    images?: DocImage[];
+    parts?: { id: string, title: string }[];
+    annotated?: string | null;
+}
+
+
+export interface DocAnalyzerProgress {
+    pages: DocAnalyzerProgressStatus,
+    images: DocAnalyzerProgressStatus,
+    tables: DocAnalyzerProgressStatus,
+    visuals: DocAnalyzerProgressStatus,
+    started_at?: number;
+    percent: number;
+}
+
+interface DocAnalyzerProgressStatus {
+    total: number;
+    processed: number;
+    success: number;
+    failed: number;
+}

package/src/store/index.ts

@@ -1,6 +1,8 @@
 export * from "./activity-catalog.js";
 export * from "./agent.js";
+export * from "./collections.js";
 export * from "./common.js";
+export * from "./doc-analyzer.js";
 export * from "./dsl-workflow.js";
 export * from "./object-types.js";
 export * from "./store.js";

package/src/store/store.ts

@@ -48,11 +48,13 @@ export interface GenerationRunMetadata {
     target?: string;
 }
 
+
+
 export interface ContentMetadata {
     // Common fields for all media types
     type?: ContentNature;
     size?: number;      // in bytes
-    language?: string;
+    languages?: string[];
     location?: Location;
     generation_runs: GenerationRunMetadata[];
     etag?: string;
@@ -81,6 +83,15 @@ export interface VideoMetadata extends TemporalMediaMetadata {
 export interface DocumentMetadata extends ContentMetadata {
     type: 'document';
     page_count?: number;
+    content_processor?: {
+        type?: string;
+        features_requested?: string[];
+        zones_requested?: string[];
+        table_count?: number;
+        image_count: number;
+        zone_count: number;
+        needs_ocr_count?: number;
+    }
 }
 
 export interface Transcript {
@@ -129,7 +140,6 @@ export interface ContentObjectItem<T = any> extends BaseObject {
         encoding: string; // the encoding used to calculate the tokens
         etag: string; //the etag of the text used for the token count
     };
-    run?: string; // the ID of the interaction run that created the object
 }
 
 /**
@@ -177,18 +187,9 @@ export interface ColumnLayout {
 }
 export interface ContentObjectType extends ContentObjectTypeItem {
     object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
-    table_layout?: ColumnLayout[]; // an optional table layout for the object properties.
 }
 export interface ContentObjectTypeItem extends BaseObject {
     is_chunkable?: boolean;
-}
-/**
- * Used to list types with their table layout if any
- */
-export interface ContentObjectTypeLayout {
-    id: string;
-    name: string;
-    description?: string;
     table_layout?: ColumnLayout[];
 }
 

package/src/store/workflow.ts

@@ -9,32 +9,57 @@ export enum ContentEventName {
 }
 
 
-export interface WorkflowExecutionPayload {
-    /**
-     * The event which started the workflow who created the activity.
-     */
-    event: ContentEventName;
-
-    /**
-     * The ref of the user who initiated the workflow.
-     */
-    initiated_by: string;
+export interface WorkflowExecutionBaseParams<T=Record<string, any>> {
+
+   /**
+    * The ref of the user who initiated the workflow.
+    */
+   initiated_by?: string;
+
+   /**
+    * The account ID of the user who created the activity.
+    * This is usefull to select the right database to work on.
+    */
+   account_id: string;
+
+   /**
+    * The project ID of the account who created the activity.
+    */
+   project_id: string;
+
+   /**
+    * The vars field is mainly used to pass the user input to the workflow.
+    * The user input ar custom user options that can be used to configure the workflow.
+    * You can see the user input as the arguments for a command line app.
+    *
+    * In the case of workflows started by events (e.g. using a a workflow rule) the user input vars will be initialized with the workflow rule configuration field.
+    *
+    * In case of dsl workflows the worflow execution payload vars will be applied over the default vars values stored in the DSL vars field.
+    */
+   vars: T;
+
+   /**
+    * Auth Token to access Zeno and Composable from the workers
+    */
+   auth_token?: string;
+
+   /**
+    * The configuration for the workflow execution.
+    */
+   config?: {
+       studio_url: string;
+       store_url: string;
+       enabled_integrations?: string[]; //list of enabled integrations
+   }
+    
+}
 
-    /**
-     * The account ID of the user who created the activity.
-     * This is usefull to select the right database to work on.
-     */
-    account_id: string;
 
+export interface WorkflowExecutionPayload<T=Record<string, any>> extends WorkflowExecutionBaseParams<T> {
     /**
-     * The project ID of the account who created the activity.
-     */
-    project_id: string;
-
-    /**
-     * The Unix timestamp when the workflow was started.
+     * The event which started the workflow who created the activity.
      */
-    timestamp: number;
+    event: ContentEventName;
 
     /*
      * The Workflow Rule ID if any. If the workflow was started by a rule this field will contain the rule ID
@@ -42,27 +67,17 @@ export interface WorkflowExecutionPayload {
      */
     wf_rule_name?: string;
 
-    /**
-     * The vars field is mainly used to pass the user input to the workflow.
-     * The user input ar custom user options that can be used to configure the workflow.
-     * You can see the user input as the arguments for a command line app.
-     *
-     * In the case of workflows started by events (e.g. using a a workflow rule) the user input vars will be initialized with the workflow rule configuration field.
-     *
-     * In case of dsl workflows the worflow execution payload vars will be applied over the default vars values stored in the DSL vars field.
-     */
-    vars: Record<string, any>;
-
-    /**
-     * Auth Token to access Zeno and Composable from the workers
-     */
-    auth_token: string;
-
     /**
      * The ID of the target objects processed by the workflow.
      */
     objectIds: string[];
 
+   /**
+    * Auth Token to access Zeno and Composable from the workers
+    */
+   auth_token: string;
+
+
     /**
      * The configuration for the workflow execution.
      */
@@ -88,6 +103,7 @@ export interface ListWorkflowRunsPayload {
     end?: string;
     status?: string;
     search_term?: string;
+    initiated_by?: string;
 }
 
 interface WorkflowRunEvent {
@@ -122,6 +138,7 @@ export interface WorkflowRun {
     execution_duration?: number,
     run_id?: string,
     workflow_id?: string,
+    initiated_by?: string,
     raw?: any
 }
 

package/src/user.ts

@@ -31,6 +31,16 @@ export enum Datacenters {
     azure = 'azure'
 }
 
+export enum BillingMethod {
+    stripe = 'stripe',
+    invoice ='invoice'
+}
+
+
+interface AccountBilling {
+    method: BillingMethod;
+    stripe_customer_id?: string;
+}
 export interface Account {
     id: string;
     name: string;
@@ -49,6 +59,8 @@ export interface Account {
 
     datacenter: string;
 
+    billing: AccountBilling;
+
     created_by: string;
     updated_by: string;
     created_at: string;
@@ -58,6 +70,7 @@ export interface Account {
 export interface UpdateAccountPayload {
     name?: string;
     email_domains?: string[];
+    billing?: AccountBilling;
 }
 
 export interface AccountRef {

package/src/utils/advanced-content-processing.ts

@@ -0,0 +1,32 @@
+import mime from 'mime';
+
+
+const ADVANCED_PROCESSING_PREFIX = 'magic-pdf';
+
+export interface AdvancedProcessingObjectFileParams {
+    objectId: string;
+    fileId: string;
+    prefix?: string;
+    contentType?: string;
+    path?: any;
+}
+
+/**
+ * 
+ * Advanced content processing only
+ * generate a file path based on object ID and file role
+ * 
+ * @returns 
+ */
+export function getPathForAdvancedProcessingFile({ objectId, prefix, fileId, contentType }: AdvancedProcessingObjectFileParams) {
+
+    const extension = contentType ? `.${mime.getExtension(contentType)}` : '';
+    const p = prefix ? `${prefix}/` : '';
+
+    let path = `${ADVANCED_PROCESSING_PREFIX}/${objectId}/${p}${fileId}`;
+    if (!path.endsWith(extension)) {
+        path += extension;
+    }
+    
+    return path;
+}