@crewdle/web-sdk-types 1.0.21 → 1.0.23

package/dist/ai/GenerativeAI.d.ts

@@ -1,4 +1,12 @@
 import { IJobParameters, IJobResult } from '../job';
+/**
+ * The AI prompt rating Enum
+ * @category AI
+ */
+export declare enum PromptRating {
+    Up = "up",
+    Down = "down"
+}
 /**
  * The AI prompt source Enum
  * @category AI
@@ -28,6 +36,23 @@ export interface IPromptHistory {
      */
     message: string;
 }
+/**
+ * The type of parameters supported for agentic functions
+ */
+export declare enum PromptFunctionParamsType {
+    /**
+     * The parameter is a string.
+     */
+    String = "string",
+    /**
+     * The parameter is a number.
+     */
+    Number = "number",
+    /**
+     * The parameter is a boolean.
+     */
+    Boolean = "boolean"
+}
 /**
  * The AI prompt function parameters Interface
  * Represents the parameters for a prompt function.
@@ -35,7 +60,7 @@ export interface IPromptHistory {
  */
 export interface IPromptFunctionParams {
     [key: string]: {
-        type: 'string' | 'number' | 'boolean';
+        type: PromptFunctionParamsType;
     };
 }
 /**
@@ -59,12 +84,24 @@ export interface IPromptFunction {
         [key: string]: string | number | boolean;
     }) => string | Promise<string>;
 }
+export type AIJobOptions = IPromptOptions | IRatingOptions;
+/**
+ * The AI options Interface
+ * Represents the options for an AI job.
+ * @category AI
+ */
+export interface IAIOptions {
+    /**
+     * The thread id
+     */
+    threadId?: string;
+}
 /**
  * The AI prompt options Interface
  * Represents the options for an AI prompt.
  * @category AI
  */
-export interface IPromptOptions {
+export interface IPromptOptions extends IAIOptions {
     /**
      * The instructions for the AI job.
      */
@@ -86,6 +123,13 @@ export interface IPromptOptions {
      */
     functions?: Map<string, IPromptFunction>;
 }
+/**
+ * The AI rating options Interface
+ * Represents the options for an AI rating.
+ * @category AI
+ */
+export interface IRatingOptions extends IAIOptions {
+}
 /**
  * The AI prompt type text
  */
@@ -99,7 +143,11 @@ export type PromptTypeVector = number[];
  * Represents the result of an AI prompt.
  * @category AI
  */
-export interface IPromptResult {
+export interface IGenerativeAIPromptResult extends IJobResultAI {
+    /**
+     * The prompt AI job type.
+     */
+    type: AIJobType.Prompt;
     /**
      * The output of the AI job.
      */
@@ -118,27 +166,129 @@ export interface IPromptResult {
     outputTokens?: number;
 }
 /**
- * The AI job parameters Interface
- * Parameters for AI job type.
+ * The AI rating status Enum
  * @category AI
  */
-export interface IJobParametersAI extends IJobParameters, IPromptOptions {
+export declare enum AIRatingStatus {
+    Success = "success",
+    Error = "error"
+}
+/**
+ * The AI rating result Interface
+ * Represents the result of an AI rating.
+ * @category AI
+ */
+export interface IGenerativeAIRatingResult extends IJobResultAI {
     /**
-     * The prompt for the AI job.
+     * The rating AI job type.
      */
-    prompt: string;
+    type: AIJobType.Rating;
+    /**
+     * The status of the rating.
+     */
+    status: AIRatingStatus;
 }
+export type GenerativeAIJobResult = IGenerativeAIPromptResult | IGenerativeAIRatingResult;
 /**
  * The AI job result Interface
  * Represents the result of an AI job.
  * @category AI
  */
-export interface IJobResultAI extends IJobResult, IPromptResult {
+export interface IJobResultAI extends IJobResult {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType;
     /**
      * The index of the output, in case of partial results.
      */
     index?: number;
 }
+/**
+ * The AI job type Enum
+ * @category AI
+ */
+export declare const enum AIJobType {
+    /**
+     * The AI job generates a prompt.
+     */
+    Prompt = "prompt",
+    /**
+     * The AI job rates a prompt.
+     */
+    Rating = "rate"
+}
+/**
+* The AI job parameters Interface
+* Parameters for AI job type.
+* @category AI
+*/
+export interface IJobParametersGenerativeAI extends IJobParameters, IPromptOptions, IRatingOptions {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType;
+    /**
+     * The thread id, if within a conversation.
+     */
+    threadId: string;
+}
+export type GenerativeAIWorkerParameters = IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters;
+export interface IGenerativeAIWorkerParameters extends IJobParametersGenerativeAI {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType;
+}
+export interface IGenerativeAIPromptWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType.Prompt;
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+}
+export interface IGenerativeAIRatingWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType.Rating;
+    /**
+     * The job ID.
+     */
+    jobId: string;
+    /**
+     * The rating for the AI prompt.
+     */
+    rating: PromptRating;
+    /**
+     * The feedback for the AI prompt
+     */
+    feedback?: string;
+}
+export type GenerativeAIWorkerConnectorParameters = IGenerativeAIPromptWorkerConnectorParameters;
+export type GenerativeAIWorkerConnectorResult = IGenerativeAIWorkerConnectorPromptResult;
+export type GenerativeAIWorkerConnectorTypes = GenerativeAIWorkerConnectorResult['type'];
+export interface IGenerativeAIWorkerConnectorPromptResult extends IGenerativeAIPromptResult {
+}
+export interface IGenerativeAIWorkerConnectorParameters {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType;
+}
+export interface IGenerativeAIPromptWorkerConnectorParameters extends IGenerativeAIWorkerConnectorParameters, IPromptOptions {
+    /**
+     * The AI job type.
+     */
+    type: AIJobType.Prompt;
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+}
 /**
  * Represents a search result.
  * @category AI

package/dist/ai/GenerativeAI.js

@@ -1,3 +1,12 @@
+/**
+ * The AI prompt rating Enum
+ * @category AI
+ */
+export var PromptRating;
+(function (PromptRating) {
+    PromptRating["Up"] = "up";
+    PromptRating["Down"] = "down";
+})(PromptRating || (PromptRating = {}));
 /**
  * The AI prompt source Enum
  * @category AI
@@ -15,3 +24,30 @@ export var PromptSource;
 })(PromptSource || (PromptSource = {}));
 ;
 ;
+/**
+ * The type of parameters supported for agentic functions
+ */
+export var PromptFunctionParamsType;
+(function (PromptFunctionParamsType) {
+    /**
+     * The parameter is a string.
+     */
+    PromptFunctionParamsType["String"] = "string";
+    /**
+     * The parameter is a number.
+     */
+    PromptFunctionParamsType["Number"] = "number";
+    /**
+     * The parameter is a boolean.
+     */
+    PromptFunctionParamsType["Boolean"] = "boolean";
+})(PromptFunctionParamsType || (PromptFunctionParamsType = {}));
+/**
+ * The AI rating status Enum
+ * @category AI
+ */
+export var AIRatingStatus;
+(function (AIRatingStatus) {
+    AIRatingStatus["Success"] = "success";
+    AIRatingStatus["Error"] = "error";
+})(AIRatingStatus || (AIRatingStatus = {}));

package/dist/ai/GenerativeAIContext.d.ts

@@ -1,23 +1,125 @@
-import { IPromptOptions, IPromptResult } from '.';
+import { AIJobType, IPromptOptions, IGenerativeAIPromptResult, IRatingOptions, IGenerativeAIRatingResult, PromptRating } from '.';
+/**
+ * Represents bounded prompt job ready to be run or streamed.
+ */
+export interface IGenerativeAIPromptJob {
+    /**
+     * The job ID.
+     */
+    id: string;
+    /**
+     * The prompt to be processed
+     */
+    prompt: string;
+    /**
+     * The options for the prompt.
+     */
+    options: IPromptOptions;
+    /**
+     * Run the prompt job.
+     * @returns A promise that resolves with the result
+     */
+    run: () => Promise<IGenerativeAIPromptResult>;
+    /**
+     * Stream the prompt job.
+     * @returns An async generator that yields the result
+     */
+    stream: () => AsyncGenerator<IGenerativeAIPromptResult>;
+}
+/**
+ * Represents a Generative AI job.
+ */
+export type GenerativeAIJob = IGenerativeAIPromptJob | IGenerativeAIRatingJob;
+/**
+ * Represents bounded rating job ready to be run or streamed.
+ */
+export interface IGenerativeAIRatingJob {
+    /**
+     * The job ID.
+     */
+    id: string;
+    /**
+     * The rating for the job.
+     */
+    rating: PromptRating;
+    /**
+     * The feedback for the job.
+     */
+    feedback?: string;
+    /**
+     * The options for the rating.
+     */
+    options: IRatingOptions;
+    /**
+     * Run the rating job.
+     * @returns A promise that resolves with the result
+     */
+    rate: () => Promise<IGenerativeAIRatingResult>;
+}
+/**
+ * Represents the parameters of an AI job.
+ */
+export type CreateAIJobParameters = IGenerativeAIPromptParameters | IGenerativeAIRatingParameters;
+/**
+ * Represents the parameters of a prompt job.
+ */
+export interface IGenerativeAIPromptParameters {
+    /**
+     * The prompt job type.
+     */
+    type: AIJobType.Prompt;
+    /**
+     * The prompt to be processed.
+     */
+    prompt: string;
+    /**
+     * The options for the prompt.
+     */
+    options?: IPromptOptions;
+}
+/**
+ * Represents the parameters of a rating job.
+ */
+export interface IGenerativeAIRatingParameters {
+    /**
+     * The rating job type.
+     */
+    type: AIJobType.Rating;
+    /**
+     * The job ID associated with the message.
+     */
+    jobId: string;
+    /**
+     * The rating of the prompt.
+     */
+    rating: PromptRating;
+    /**
+     * The feedback for the prompt.
+     */
+    feedback?: string;
+    /**
+     * The options for the rating.
+     */
+    options?: IRatingOptions;
+}
 /**
  * Represents a context for a Generative AI service.
  * @category AI
  */
 export interface IGenerativeAIContext {
     /**
-     * Stream the response from the AI service.
-     * @param prompt The prompt to start processing.
-     * @param options Optional parameters for the prompt.
-     * @returns An async generator that yields the response.
+     * Create an AI job. The job is bounded to the context.
+     * @param parameters The parameters of the AI job.
+     * @returns The job ready to be run or streamed.
      */
-    stream(prompt: string, options?: IPromptOptions): AsyncGenerator<IPromptResult>;
+    createAIJob(parameters: IGenerativeAIPromptParameters): IGenerativeAIPromptJob;
+    createAIJob(parameters: IGenerativeAIRatingParameters): IGenerativeAIRatingJob;
     /**
-     * Process the response from the AI service.
-     * @param prompt The prompt to start processing.
-     * @param options Optional parameters for the prompt.
-     * @returns A promise that resolves with the response.
+     * Rate a prompt.
+     * @param parameters The parameters of the rating job.
+     * @returns A promise that resolves with the result.
      */
-    prompt(prompt: string, options?: IPromptOptions): Promise<IPromptResult>;
+    ratePrompt(parameters: IGenerativeAIRatingParameters): Promise<IGenerativeAIRatingResult>;
     /**
      * Get the data bucket IDs.
      * @returns An array of data bucket IDs.

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -1,5 +1,5 @@
 import { IJobWorkerConnector, IJobWorkerOptions } from '../job';
-import { IJobParametersAI, IJobResultAI } from './GenerativeAI';
+import { GenerativeAIWorkerConnectorParameters, IGenerativeAIPromptWorkerConnectorParameters, IGenerativeAIWorkerConnectorPromptResult, GenerativeAIWorkerConnectorResult } from './GenerativeAI';
 /**
  * The generative AI model input types.
  * @category AI
@@ -85,7 +85,7 @@ export interface IGenerativeAIWorkerOptions extends IJobWorkerOptions {
  * The generative AI worker connector interface.
  * @category Connector
  */
-export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<IJobParametersAI, IJobResultAI> {
+export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<GenerativeAIWorkerConnectorParameters, GenerativeAIWorkerConnectorResult> {
     /**
      * Initialize the machine learning model.
      * @param workflowId The workflow ID.
@@ -109,12 +109,14 @@ export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<IJobPa
      * @param options The job options.
      * @returns A promise that resolves with the job result.
      */
-    processJob(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): Promise<IJobResultAI>;
+    processJob(parameters: IGenerativeAIPromptWorkerConnectorParameters, options?: IGenerativeAIWorkerOptions): Promise<IGenerativeAIWorkerConnectorPromptResult>;
+    processJob(parameters: GenerativeAIWorkerConnectorParameters, options?: IGenerativeAIWorkerOptions): Promise<GenerativeAIWorkerConnectorResult>;
     /**
      * Stream a job.
      * @param parameters The job parameters.
      * @param options The job options.
      * @returns An async generator that yields the job result.
      */
-    processJobStream(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): AsyncGenerator<IJobResultAI>;
+    processJobStream(parameters: IGenerativeAIPromptWorkerConnectorParameters, options?: IGenerativeAIWorkerOptions): AsyncGenerator<IGenerativeAIWorkerConnectorPromptResult>;
+    processJobStream(parameters: GenerativeAIWorkerConnectorParameters, options?: IGenerativeAIWorkerOptions): AsyncGenerator<GenerativeAIWorkerConnectorResult>;
 }

package/dist/graph-database/GraphDatabase.d.ts

@@ -31,6 +31,11 @@ export interface IGraphDatabase extends IDataStream {
      * @param to The node to add the edge to.
      */
     addEdge(from: string, to: string): void;
+    /**
+     * Remove content from the database.
+     * @param name The name of the content to remove.
+     */
+    remove(name: string): void;
     /**
      * Get the content of the nodes and their neighbors.
      * @param nodes The nodes to get the content of.

package/dist/graph-database/GraphDatabaseConnector.d.ts

@@ -28,6 +28,11 @@ export interface IGraphDatabaseConnector {
     getContent(nodes: string[], maxDepth?: number, contentSize?: number): {
         [key: string]: string[];
     };
+    /**
+     * Remove content from the database.
+     * @param name The name of the content to remove.
+     */
+    remove(name: string): void;
     /**
      * Get the size of the database
      * @returns The size of the database.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",