@vertesia/common 0.42.2

package/src/access-control.ts

@@ -0,0 +1,77 @@
+/**
+ * @module access-control
+ * @description
+ * Access control interfaces
+ */
+
+import { ProjectRoles } from "./project.js";
+
+export enum Permission {
+    int_read = "interaction:read",
+    int_write = "interaction:write",
+    int_delete = "interaction:delete",
+
+    int_execute = "interaction:execute",
+    run_read = "run:read",
+    run_write = "run:write",
+
+    env_manage = "environment:manage",
+
+    project_manage = "project:manage",
+
+    api_key_create = "api_key:create",
+    api_key_read = "api_key:read",
+
+    account_read = "account:read",
+    account_manage = "account:manage",
+    manage_billing = "account:billing",
+    account_member = "account:member",
+
+
+    content_read = "content:read",
+    content_create = "content:create",
+    content_update = "content:update",
+    content_delete = "content:delete",
+
+    content_admin = "content:admin", //manage schemas, workflows, rules
+
+    workflow_run = "workflow:run",
+}
+
+export enum AccessControlledResource {
+    project = "project",
+    environment = "environment",
+    account = "account",
+    interaction = "interaction",
+}
+
+
+export interface AccessControlEntry {
+    role: ProjectRoles;
+    resource: string; //objectId
+    principal: string; //objectId
+    type: AccessControlledResource;
+    tags?: string[];
+    expires_at?: string;
+    created_at?: string;
+    updated_at?: string;
+    id: string;
+}
+
+export interface ACECreatePayload extends
+    Omit<AccessControlEntry, "created_at" | "updated_at" | "id"> {
+}
+
+export interface ACEUpdatePayload extends Partial<ACECreatePayload> {
+}
+
+
+export interface AcesQueryOptions {
+
+    level?: 'resource' | 'project' | 'account'
+    resource?: string
+    principal?: string
+    role?: string
+    type?: AccessControlledResource
+
+}

package/src/analytics.ts

@@ -0,0 +1,49 @@
+
+export interface AnalyticsAxis {
+    environment?: string;
+    project?: string;
+    interactions?: string[];
+    models?: string[];
+    status?: string[];
+    tags?: string[];
+    selectedOnly?: boolean;
+}
+
+export interface RunAnalyticsQuery {
+
+    /** filters to apply to the query */
+    filterBy: AnalyticsAxis;
+
+    /** The field to group by */
+    groupBy?: RunAnalyticsGroupBy
+
+    /** The start date of the query in EPOCH format */
+    from?: number;
+    /** The end date of the query in EPOCH format */
+    to?: number;
+
+    /** The time resolution of the analytics query */
+    resolution?: TimeResolution;
+
+    /** The field to sort by */
+    virtual?: boolean;
+
+}
+
+
+export type RunAnalyticsGroupBy = "interaction" | "modelId" | "project" | "status" | "tags" | "environment";
+
+export type TimeResolution = "hour" | "day" | "week" | "month" | "year";
+
+
+export interface RunAnalyticsResult {
+    date: string,
+    timestamp: string,
+    group: string
+    count: number,
+    execution_time: {
+        avg: number,
+        min: number,
+        max: number
+    },
+}

package/src/apikey.ts

@@ -0,0 +1,68 @@
+import { ProjectRef, ProjectRoles } from "./project.js";
+import { AccountRef } from "./user.js";
+
+
+export enum ApiKeyTypes {
+    public = 'pk',
+    secret = 'sk'
+}
+export interface ApiKey {
+    id: string;
+    name: string;
+    type: ApiKeyTypes;
+    role: ProjectRoles;
+    maskedValue?: string; //masked value
+    account: string; // the account id
+    project: string; // the project id if any
+    enabled: boolean;
+    created_by: string,
+    updated_by: string,
+    created_at: Date;
+    updated_at: Date;
+    expires_at?: Date; // in case of public key only
+}
+
+
+export interface CreateOrUpdateApiKeyPayload extends Partial<ApiKey> {
+
+}
+
+export interface ApiKeyWithValue extends Omit<ApiKey, 'maskedValue'> {
+    value: string;
+}
+
+
+export interface CreatePublicKeyPayload {
+    name?: string,
+    projectId?: string,
+    ttl?: number,
+}
+
+export interface AuthTokenResponse {
+    token: string;
+}
+
+export interface AuthTokenPayload {
+    sub: string
+    name: string;
+    email?: string;
+    picture?: string;
+
+    type: PrincipalType
+    account: AccountRef;
+    account_roles: ProjectRoles[];
+    accounts: AccountRef[];
+    project?: ProjectRef;
+    project_roles?: ProjectRoles[];
+
+    iss: string; //issuer
+    aud: string; //audience
+    exp: number; //expires in (EPOC seconds)
+}
+
+
+export enum PrincipalType {
+    User = "user",
+    ApiKey = "apikey",
+    ServiceAcount = "service_account",
+}

package/src/common.ts

@@ -0,0 +1,34 @@
+export interface FindPayload {
+    query: Record<string, any>;
+    limit?: number;
+    select?: string;
+}
+
+
+export interface GenericCommandResponse {
+    status: string;
+    message: string;
+    err?: any;
+    details?: any;
+}
+
+export interface BulkOperationPayload {
+    /**
+     * The operation name
+     */
+    name: "change_type" | "delete" | "start_workflow" | "update";
+
+    /**
+     * The IDs of the objects to operate on
+     */
+    ids: string[];
+
+    /**
+     * The operation parameters.
+     */
+    params: Record<string, any>;
+}
+
+export interface BulkOperationResult {
+    status: "in_progress" | "completed" | "failed";
+}

package/src/environment.ts

@@ -0,0 +1,193 @@
+import { AIModel, ModelOptions } from "@llumiverse/core";
+
+
+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_lb = 'virtual_lb',
+    virtual_mediator = 'virtual_mediator',
+    test = 'test'
+}
+
+export interface SupportedProviderParams {
+    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':
+    {
+        id: SupportedProviders.virtual_lb,
+        name: "Virtual - Load Balancer",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    'virtual_mediator':
+    {
+        id: SupportedProviders.virtual_mediator,
+        name: "Virtual - Mediator",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    'test': {
+        id: SupportedProviders.test,
+        name: "Test LLM",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+};
+
+
+export interface VirtualEnvEntry {
+    model: string;
+}
+
+/**
+ * Custom configuration for virtual environments
+ **/
+export interface LoadBalancingEnvConfig {
+    entries?: LoadBalancingEnvEntryConfig[];
+    balance_if_failed?: boolean;
+}
+
+export interface LoadBalancingEnvEntryConfig extends VirtualEnvEntry {
+    weight: number;
+}
+
+export interface MediatorEnvConfig extends ModelOptions{
+    entries?: VirtualEnvEntry[];
+    max_concurrent_requests?: number;
+    // the model used to evaluate the responses. If not specified all entries will mediates the response
+    // and the best response will be picked
+    mediators?: VirtualEnvEntry[];
+}
+
+export interface ExecutionEnvironment {
+    id: string;
+    name: string;
+    provider: SupportedProviders;
+    description?: string;
+    endpoint_url?: string;
+    default_model?: string;
+    enabled_models?: AIModel[];
+    apiKey?: string;
+    config?: any;
+    account: string;
+    allowed_projects?: string[];
+    created_by: string,
+    updated_by: string,
+    created_at: string;
+    updated_at: string;
+}
+
+export interface ExecutionEnvironmentRef {
+    id: string;
+    name: string;
+    provider: SupportedProviders;
+    enabled_models?: AIModel[];
+    default_model?: string;
+    endpoint_url?: string;
+    allowed_projects?: string[];
+    account: string;
+    created_by: string;
+    updated_by: string;
+    created_at: string;
+    updated_at: string;
+}
+
+export const ExecutionEnvironmentRefPopulate = "id name provider enabled_models default_model endpoint_url allowed_projects account created_at updated_at";
+
+export interface ExecutionEnvironmentCreatePayload extends Omit<ExecutionEnvironment, 'id' | 'account' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by' | 'project'> { }
+export interface ExecutionEnvironmentUpdatePayload extends Partial<Omit<ExecutionEnvironment, 'id' | 'account' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'>> { }

package/src/facets.ts

@@ -0,0 +1,44 @@
+
+// this is the mongo definition of a facet. see https://www.mongodb.com/docs/atlas/atlas-search/facet/
+export interface StringFacet {
+    type: "string",
+    path: string,
+    numBuckets?: number,
+}
+
+export interface NumericFacet {
+    type: "number",
+    path: string,
+    boundaries: number[],
+    default?: string
+}
+
+export interface DateFacet<T extends (Date | string) = string> {
+    type: "date",
+    path: string,
+    boundaries: T[], // array of dates
+    default?: string
+}
+
+export type Facet<DateT extends (Date | string) = string> = StringFacet | NumericFacet | DateFacet<DateT>;
+
+
+export interface FacetSpec {
+    name: string;
+    field: string;
+}
+
+export interface FacetBucket {
+    _id: string,
+    count: number,
+}
+
+export interface FacetNameBucket {
+    name: string,
+    _id: string,
+    count: number,
+}
+
+export interface FacetResult {
+    buckets: FacetBucket[]
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+export * from './access-control.js';
+export * from './analytics.js';
+export * from './apikey.js';
+export * from './common.js';
+export * from './environment.js';
+export * from "./facets.js";
+export * from './integrations.js';
+export * from './interaction.js';
+export * from './payload.js';
+export * from './project.js';
+export * from './prompt.js';
+export * from './query.js';
+export * from './refs.js';
+export * from './runs.js';
+export * from "./store/index.js";
+export * from "./training.js";
+export * from './transient-tokens.js';
+export * from './user.js';
+export * from './utils/auth.js';
+export * from './utils/schemas.js';

package/src/integrations.ts

@@ -0,0 +1,25 @@
+
+
+export interface IntegrationConfigurationBase {
+    enabled: boolean;
+}
+
+export interface GladiaConfiguration extends IntegrationConfigurationBase {
+    api_key: string;
+    url?: string;
+}
+
+
+export interface GithubConfiguration extends IntegrationConfigurationBase {
+    allowed_repositories: string[];
+}
+
+export interface AwsConfiguration extends IntegrationConfigurationBase {
+    s3_role_arn: string;
+}
+
+export enum SupportedIntegrations {
+    gladia = "gladia",
+    github = "github",
+    aws = "aws"
+}