@vertesia/common 0.67.0 → 0.68.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertesia/common",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "type": "module",
   "types": "./lib/types/index.d.ts",
   "files": [

package/src/access-control.ts

@@ -15,9 +15,11 @@ export enum Permission {
     run_read = "run:read",
     run_write = "run:write",
 
-    env_manage = "environment:manage",
+    env_admin = "environment:admin",
 
-    project_manage = "project:manage",
+    project_admin = "project:admin",
+    project_integration_read = "project:integration_read",
+    project_settings_write = "project:settings_write",
 
     api_key_create = "api_key:create",
     api_key_read = "api_key:read",
@@ -25,19 +27,19 @@ export enum Permission {
     api_key_delete = "api_key:delete",
 
     account_read = "account:read",
-    account_manage = "account:manage",
+    account_admin = "account:admin",
     manage_billing = "account:billing",
     account_member = "account:member",
 
 
     content_read = "content:read",
-    content_create = "content:create",
-    content_update = "content:update",
+    content_write = "content:write",
     content_delete = "content:delete",
 
-    content_admin = "content:admin", //manage schemas, workflows, rules
+    content_admin = "content:admin", //manage schemas
 
     workflow_run = "workflow:run",
+    workflow_admin = "workflow:admin",
 }
 
 export enum AccessControlResourceType {

package/src/apikey.ts

@@ -4,7 +4,6 @@ import { AccountRef } from "./user.js";
 
 
 export enum ApiKeyTypes {
-    public = 'pk',
     secret = 'sk'
 }
 export interface ApiKey {

package/src/environment.ts

@@ -1,127 +1,43 @@
-import type { AIModel, TextFallbackOptions } from "@llumiverse/common";
+import type { AIModel, ProviderParams, TextFallbackOptions } from "@llumiverse/common";
+import { ProviderList, Providers } from "@llumiverse/common";
 
-
-export enum SupportedProviders {
-    // from llumiverse
-    openai = 'openai',
-    azure_openai = 'azure_openai',
-    huggingface_ie = 'huggingface_ie',
-    replicate = 'replicate',
-    bedrock = 'bedrock',
-    vertexai = 'vertexai',
-    togetherai = 'togetherai',
-    mistralai = 'mistralai',
-    groq = 'groq',
-    watsonx = 'watsonx',
-    // from studio
+// Virtual providers from studio
+export enum CustomProviders {
     virtual_lb = 'virtual_lb',
     virtual_mediator = 'virtual_mediator',
     test = 'test'
 }
 
-export interface SupportedProviderParams {
+export type SupportedProviders = Providers | CustomProviders;
+
+export const SupportedProviders = {
+    ...Providers,
+    ...CustomProviders
+} as const;
+
+export interface SupportedProviderParams extends Omit<ProviderParams, 'id'> {
     id: SupportedProviders;
-    name: string;
-    requiresApiKey: boolean;
-    requiresEndpointUrl: boolean;
-    endpointPlaceholder?: string;
-    supportSearch?: boolean;
 }
 
-export const SupportedProvidersList: Record<SupportedProviders, SupportedProviderParams> = {
-    'openai':
-    {
-        id: SupportedProviders.openai,
-        name: "OpenAI",
-        requiresApiKey: true,
-        requiresEndpointUrl: false,
-        supportSearch: false,
-    },
-    'azure_openai':
-    {
-        id: SupportedProviders.azure_openai,
-        name: "Azure OpenAI",
-        requiresApiKey: false,
-        requiresEndpointUrl: true,
-        supportSearch: false,
-    },
-    'huggingface_ie':
-    {
-        id: SupportedProviders.huggingface_ie,
-        name: "HuggingFace Inference Endpoint",
-        requiresApiKey: true,
-        requiresEndpointUrl: true,
-    },
-    'replicate':
-    {
-        id: SupportedProviders.replicate,
-        name: "Repicate",
-        requiresApiKey: true,
-        requiresEndpointUrl: false,
-        supportSearch: true,
-    },
-    'bedrock':
-    {
-        id: SupportedProviders.bedrock,
-        name: "AWS Bedrock",
-        requiresApiKey: false,
-        requiresEndpointUrl: false,
-        endpointPlaceholder: "region name (eg. us-east-1)",
-        supportSearch: false,
-    },
-    vertexai: {
-        id: SupportedProviders.vertexai,
-        name: "Google Vertex AI",
-        requiresApiKey: false,
-        requiresEndpointUrl: false,
-        supportSearch: false,
-    },
-    togetherai: {
-        id: SupportedProviders.togetherai,
-        name: "Together AI",
-        requiresApiKey: false,
-        requiresEndpointUrl: false,
-        supportSearch: false,
-    },
-    mistralai: {
-        id: SupportedProviders.mistralai,
-        name: "Mistral AI",
-        requiresApiKey: false,
-        requiresEndpointUrl: false,
-        supportSearch: false,
-    },
-    groq: {
-        id: SupportedProviders.groq,
-        name: "Groq Cloud",
-        requiresApiKey: false,
-        requiresEndpointUrl: false,
-        supportSearch: false,
-    },
-    watsonx: {
-        id: SupportedProviders.watsonx,
-        name: "IBM WatsonX",
-        requiresApiKey: true,
-        requiresEndpointUrl: true,
-        supportSearch: false
-    },
-    'virtual_lb':
+export const CustomProvidersList: Record<CustomProviders, SupportedProviderParams> = {
+    virtual_lb:
     {
-        id: SupportedProviders.virtual_lb,
+        id: CustomProviders.virtual_lb,
         name: "Virtual - Load Balancer",
         requiresApiKey: false,
         requiresEndpointUrl: false,
         supportSearch: false,
     },
-    'virtual_mediator':
+    virtual_mediator:
     {
-        id: SupportedProviders.virtual_mediator,
+        id: CustomProviders.virtual_mediator,
         name: "Virtual - Mediator",
         requiresApiKey: false,
         requiresEndpointUrl: false,
         supportSearch: false,
     },
-    'test': {
-        id: SupportedProviders.test,
+    test: {
+        id: CustomProviders.test,
         name: "Test LLM",
         requiresApiKey: false,
         requiresEndpointUrl: false,
@@ -129,6 +45,11 @@ export const SupportedProvidersList: Record<SupportedProviders, SupportedProvide
     },
 };
 
+export const SupportedProvidersList: Record<SupportedProviders, SupportedProviderParams> = {
+    ...ProviderList,
+    ...CustomProvidersList
+} as const;
+
 
 export interface VirtualEnvEntry {
     model: string;

package/src/group.ts

@@ -23,4 +23,4 @@ export interface UserGroupRef {
     tags?: string[];
 }
 
-export const UserGroupRefPopulate = 'id name tags';
+export const UserGroupRefPopulate = 'id name tags description';

package/src/interaction.ts

@@ -263,7 +263,7 @@ export interface InteractionExecutionPayload {
     /**
      * The tools to be used in the execution
      */
-    tools?: ToolDefinition[];
+    tool_definitions?: ToolDefinition[];
 
     /**
      * The workflow related to this Interaction Run.
@@ -283,43 +283,13 @@ export interface NamedInteractionExecutionPayload extends InteractionExecutionPa
 // ================= async execution payloads ====================
 export type ToolRef = string | { name: string; description: string };
 
-interface AsyncExecutionPayloadBase {
+interface AsyncExecutionPayloadBase extends Omit<NamedInteractionExecutionPayload,"toolDefinitions" | "stream"> {
     type: "conversation" | "interaction";
 
     /**
-     * The interaction endpoint to execute to start the conversation.
+     * An array of endpoint URLs to be notified upon execution
      */
-    interaction: string;
-
-    /**
-     * The environment ID to use.
-     */
-    environment?: string;
-
-    /**
-     * The model to use
-     */
-    model?: string;
-
-    /**
-     * The options to use on the first execution
-     */
-    model_options?: ModelOptions;
-
-    /**
-     * The initial prompt input data
-     */
-    prompt_data?: Record<string, any>;
-
-    /**
-     * Optional result schema
-     */
-    result_schema?: JSONSchema;
-
-    /**
-     * Optional tags to add to the execution run
-     */
-    tags?: string[];
+    notify_endpoints?: string[];
 }
 
 export type ConversationVisibility = 'private' | 'project';
@@ -337,7 +307,7 @@ export interface AsyncConversationExecutionPayload extends AsyncExecutionPayload
      * The tools to use, list of tool or function names.
      * You can use + and - to add or remove from default, if no sign, then list replaces default
      */
-    tools?: string[];
+    tool_names?: string[];
 
     /**
      * The maximum number of iterations in case of a conversation. If <=0 the default of 20 will be used.
@@ -383,11 +353,6 @@ export interface AsyncConversationExecutionPayload extends AsyncExecutionPayload
 export interface AsyncInteractionExecutionPayload extends AsyncExecutionPayloadBase {
     type: "interaction";
 
-    /**
-     * The tools to use
-     */
-    tools?: ToolDefinition[];
-
     /**
      * Only used for non conversation workflows to include the error on next retry.
      * If tools is defined this is not used

package/src/payload.ts

@@ -1,5 +1,6 @@
 import { FacetSpec } from "./facets.js";
 import {
+    ComplexCollectionSearchQuery,
     ComplexSearchQuery,
     InteractionSearchQuery,
     ObjectSearchQuery,
@@ -43,6 +44,10 @@ export interface RunSearchPayload extends SearchPayload {
     query?: RunSearchQuery;
 }
 
+export interface ComputeCollectionFacetPayload extends Omit<ComputeFacetPayload, 'query'> {
+    query?: ComplexCollectionSearchQuery;
+}
+
 export interface ComputeInteractionFacetPayload extends ComputeFacetPayload {
     query?: InteractionSearchQuery;
 }

package/src/query.ts

@@ -1,5 +1,6 @@
 import { ExecutionRunStatus } from './interaction.js';
 import { SupportedEmbeddingTypes } from './project.js';
+import { CollectionSearchPayload } from './store/collections.js';
 
 export interface RunListingQueryOptions {
     project?: string;
@@ -18,6 +19,7 @@ export interface RunListingFilters {
     fromDate?: string,
     toDate?: string,
     parent?: string | false,
+    workflow_run_ids?: string[],
 }
 
 export interface VectorSearchQuery {
@@ -77,6 +79,7 @@ export interface RunSearchQuery extends SimpleSearchQuery {
     end?: string;
     finish_reason?: string;
     created_by?: string;
+    workflow_run_ids?: string[];
 }
 
 export interface WorkflowExecutionSearchQuery extends SimpleSearchQuery {
@@ -91,4 +94,8 @@ export interface WorkflowExecutionSearchQuery extends SimpleSearchQuery {
 export interface ComplexSearchQuery extends ObjectSearchQuery {
     vector?: VectorSearchQuery;
     match?: Record<string, any>;
+}
+
+export interface ComplexCollectionSearchQuery extends CollectionSearchPayload {
+    match?: Record<string, any>;
 }

package/src/refs.ts

@@ -25,4 +25,5 @@ export interface ResourceRef {
     id: string
     name: string
     type: string
+    description?: string
 }

package/src/store/collections.ts

@@ -66,4 +66,5 @@ export interface CollectionSearchPayload {
     limit?: number;
     offset?: number;
     name?: string;
+    type?: string;
 }

package/src/store/workflow.ts

@@ -228,7 +228,7 @@ interface WorkflowRunEvent {
         }
         recipient?: {
             workflowId?: string,
-            runId?: string 
+            runId?: string
         },
         initiatedEventId?: string,
     }
@@ -260,7 +260,7 @@ export interface WorkflowRun {
     interaction_name?: string;
     input?: any;
     result?: any;
-    error?:any,
+    error?: any,
     raw?: any;
     /**
      * The Vertesia Workflow Type of this Workflow Run.
@@ -376,6 +376,7 @@ export enum AgentMessageType {
     QUESTION = "question",
     REQUEST_INPUT = "request_input",
     IDLE = "idle",
+    TERMINATED = "terminated",
 }
 
 export interface PlanTask {