@crewdle/web-sdk-types 1.0.21 → 1.0.22

package/dist/ai/GenerativeAI.d.ts

@@ -85,6 +85,10 @@ export interface IPromptOptions {
      * The functions that can be called by the LLM.
      */
     functions?: Map<string, IPromptFunction>;
+    /**
+     * The thread id
+     */
+    threadId?: string;
 }
 /**
  * The AI prompt type text
@@ -127,6 +131,10 @@ export interface IJobParametersAI extends IJobParameters, IPromptOptions {
      * The prompt for the AI job.
      */
     prompt: string;
+    /**
+     * The thread id, if within a conversation.
+     */
+    threadId: string;
 }
 /**
  * The AI job result Interface

package/dist/ai/GenerativeAIContext.d.ts

@@ -1,23 +1,43 @@
 import { IPromptOptions, IPromptResult } 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<IPromptResult>;
+    /**
+     * Stream the prompt job.
+     * @returns An async generator that yields the result
+     */
+    stream: () => AsyncGenerator<IPromptResult>;
+}
 /**
  * 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.
-     */
-    stream(prompt: string, options?: IPromptOptions): AsyncGenerator<IPromptResult>;
-    /**
-     * 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.
+     * Create a prompt job. The prompt job is bounded to the context.
+     * @param prompt The prompt to be processed.
+     * @param options The options for the prompt job.
+     * @returns The prompt job ready to be run or streamed.
      */
-    prompt(prompt: string, options?: IPromptOptions): Promise<IPromptResult>;
+    createAIJob(prompt: string, options?: IPromptOptions): IGenerativeAIPromptJob;
     /**
      * Get the data bucket IDs.
      * @returns An array of data bucket IDs.

package/package.json

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