@crewdle/web-sdk-types 1.0.13 → 1.0.14

package/dist/ai/GenerativeAI.d.ts

@@ -0,0 +1,89 @@
+import { IJobParameters, IJobResult } from '../job';
+/**
+ * The AI prompt source Enum
+ */
+export declare enum PromptSource {
+    /**
+     * The prompt was generated by the AI.
+     */
+    AI = "ai",
+    /**
+     * The prompt was generated by a human.
+     */
+    Human = "human"
+}
+/**
+ * The AI prompt history Interface
+ * Represents the history of a prompt.
+ * @ignore
+ */
+export interface IPromptHistory {
+    /**
+     * The source of the prompt.
+     */
+    source: PromptSource;
+    /**
+     * The prompt.
+     */
+    message: string;
+}
+export interface IPromptOptions {
+    /**
+     * The instructions for the AI job.
+     */
+    instructions?: string;
+    /**
+     * Whether to use RAG for the AI job.
+     */
+    useRAG?: boolean;
+    /**
+     * The context for the AI job.
+     */
+    context?: IPromptHistory[];
+}
+/**
+ * The AI job parameters Interface
+ * Parameters for AI job type.
+ * @ignore
+ */
+export interface IJobParametersAI extends IJobParameters {
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+    /**
+     * The instructions for the AI job.
+     */
+    instructions?: string;
+    /**
+     * Whether to use RAG for the AI job.
+     */
+    useRAG?: boolean;
+    /**
+     * The context for the AI job.
+     */
+    context?: IPromptHistory[];
+}
+/**
+ * The AI job result Interface
+ * Represents the result of an AI job.
+ * @ignore
+ */
+export interface IJobResultAI extends IJobResult {
+    /**
+     * The output of the AI job.
+     */
+    output: string;
+    /**
+     * The tokens used by the AI job.
+     */
+    inputTokens?: number;
+    /**
+     * The tokens generated by the AI job.
+     */
+    outputTokens?: number;
+    /**
+     * The index of the output, in case of partial results.
+     */
+    index?: number;
+}

package/dist/ai/GenerativeAI.js

@@ -0,0 +1,16 @@
+/**
+ * The AI prompt source Enum
+ */
+export var PromptSource;
+(function (PromptSource) {
+    /**
+     * The prompt was generated by the AI.
+     */
+    PromptSource["AI"] = "ai";
+    /**
+     * The prompt was generated by a human.
+     */
+    PromptSource["Human"] = "human";
+})(PromptSource || (PromptSource = {}));
+;
+;

package/dist/ai/GenerativeAIContext.d.ts

@@ -1,14 +1,21 @@
+import { IPromptOptions } from '.';
 /**
  * Represents a context for a Generative AI service.
  * @category AI
  */
 export interface IGenerativeAIContext {
     /**
-     * Prompt the Generative AI Context to start processing a prompt.
+     * Stream the response from the AI service.
      * @param prompt The prompt to start processing.
-     * @returns The response from the AI service.
+     * @returns An async generator that yields the response.
      */
-    prompt(prompt: string): AsyncGenerator<string>;
+    stream(prompt: string, options?: IPromptOptions): AsyncGenerator<string>;
+    /**
+     * Process the response from the AI service.
+     * @param prompt The prompt to start processing.
+     * @returns A promise that resolves with the response.
+     */
+    prompt(prompt: string, options?: IPromptOptions): Promise<string>;
     /**
      * Close the Generative AI Context.
      */

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -1,9 +1,10 @@
-import { IJob, IJobWorkerConnector, IJobResult } from '../job';
+import { IJobRequest, IJobWorkerConnector, JobResponse } from '../job';
+import { IJobParametersAI, IJobResultAI } from './GenerativeAI';
 /**
  * The generative AI worker connector interface.
  * @category Connector
  */
-export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector {
+export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<IJobParametersAI, IJobResultAI> {
     /**
      * Initialize the machine learning model.
      * @param llmModel The path to the LLM model.
@@ -26,7 +27,13 @@ export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector {
     /**
      * Process a job.
      * @param job The job to process.
+     * @returns A promise that resolves with the job result.
+     */
+    processJob(job: IJobRequest<IJobParametersAI>): Promise<JobResponse<IJobResultAI>>;
+    /**
+     * Stream a job.
+     * @param job The job to stream.
      * @returns An async generator that yields the job result.
      */
-    processJob(job: IJob): AsyncGenerator<IJobResult>;
+    processJobStream(job: IJobRequest<IJobParametersAI>): AsyncGenerator<JobResponse<IJobResultAI>>;
 }

package/dist/ai/index.d.ts

@@ -1,3 +1,4 @@
+export * from './GenerativeAI';
 export * from './GenerativeAIContext';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';

package/dist/ai/index.js

@@ -1,3 +1,4 @@
+export * from './GenerativeAI';
 export * from './GenerativeAIContext';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';

package/dist/job/Job.d.ts

@@ -1,9 +1,16 @@
 /**
- * IJob Interface
+ * Base IJobParameters Interface
+ * Allows providing parameters specific to the job type.
+ * @ignore
+ */
+export interface IJobParameters {
+}
+/**
+ * Job request Interface
  * Represents a job to be executed by the JobService.
  * @ignore
  */
-export interface IJob {
+export interface IJobRequest<T extends IJobParameters> {
     /**
      * The ID of the job.
      */
@@ -11,20 +18,30 @@ export interface IJob {
     /**
      * The parameters of the job.
      */
-    parameters: JobParameters;
+    parameters: T;
     /**
     * The status of the job.
     */
     status?: JobStatus;
+    /**
+     * The type of the job.
+     */
+    jobType: JobType;
 }
 /**
  * JobType Enum
- * Provide this to create a job with a specific type.
+ * Represents the type of a job.
  * @ignore
  */
 export declare enum JobType {
-    AI = 0,
-    Other = 1
+    /**
+     * The job is expected to return a Promise with a result.
+     */
+    Job = "job",
+    /**
+     * The job is expected to return a stream iterator with results.
+     */
+    JobStream = "job-stream"
 }
 /**
  * JobStatus Enum
@@ -54,60 +71,53 @@ export declare enum JobStatus {
     Failed = "failed"
 }
 /**
- * Base IJobParameters Interface
- * Allows providing parameters specific to the job type.
- * @ignore
- */
-export interface IJobParameters {
-    jobType: JobType;
-}
-/**
- * IJobParametersAI Interface
- * Parameters for AI job type.
+ * Base job result Interface
+ * Represents the result of a job.
  * @ignore
  */
-export interface IJobParametersAI extends IJobParameters {
-    jobType: JobType.AI;
-    prompt: string;
+export interface IJobResult {
 }
 /**
- * JobParameters Type
- * Union of all job parameters interfaces.
- * @ignore
- */
-export type JobParameters = IJobParametersAI;
-/**
- * IJobResult Interface
- * Represents the result of a job.
+ * Job response Interface
+ * Represents the response from a job.
  * @ignore
  */
-export interface IJobResult {
+export interface IJobResultResponse<T extends IJobResult> {
     /**
      * The ID of the job.
      */
     id: string;
     /**
-     * The status of the job result.
+     * The status of the job.
      */
-    status: JobStatus;
+    status: JobStatus.Partial | JobStatus.Completed;
     /**
      * The result of the job.
      */
-    result: JobResult;
+    result: T;
 }
 /**
- * IJobResultAI Interface
- * Represents the result of an AI job.
+ * Job failed response Interface
+ * Represents a failed job response.
  * @ignore
  */
-export interface IJobResultAI {
-    jobType: JobType.AI;
-    output: string;
-    index?: number;
+export interface IJobFailedResponse {
+    /**
+     * The ID of the job.
+     */
+    id: string;
+    /**
+     * The status of the job.
+     */
+    status: JobStatus.Failed;
+    /**
+     * The error message.
+     */
+    message: string;
 }
 /**
- * JobResult Type
- * Union of all job result interfaces.
+ * Job response type
+ * Represents the response type from a job.
  * @ignore
  */
-export type JobResult = IJobResultAI;
+export type JobResponse<T extends IJobResult> = IJobResultResponse<T> | IJobFailedResponse;

package/dist/job/Job.js

@@ -1,12 +1,18 @@
 /**
  * JobType Enum
- * Provide this to create a job with a specific type.
+ * Represents the type of a job.
  * @ignore
  */
 export var JobType;
 (function (JobType) {
-    JobType[JobType["AI"] = 0] = "AI";
-    JobType[JobType["Other"] = 1] = "Other";
+    /**
+     * The job is expected to return a Promise with a result.
+     */
+    JobType["Job"] = "job";
+    /**
+     * The job is expected to return a stream iterator with results.
+     */
+    JobType["JobStream"] = "job-stream";
 })(JobType || (JobType = {}));
 /**
  * JobStatus Enum

package/dist/job/JobDispatcher.d.ts

@@ -1,28 +1,27 @@
 import type { Observable } from 'rxjs';
 import { IDataStream } from '../core/stream';
-import { IJob, IJobResult } from './Job';
+import { IJobParameters, IJobRequest, IJobResult, JobResponse } from './Job';
 /**
  * The Job Dispatcher interface.
  * @ignore
  */
-export interface IJobDispatcher extends IDataStream {
+export interface IJobDispatcher<T extends IJobParameters, U extends IJobResult> extends IDataStream {
     /**
      * Create a new job.
-     * @param jobId The ID of the job.
-     * @param parameters The parameters of the job.
+     * @param job The job to create.
      */
-    createJob(job: IJob): Promise<Observable<IJobResult>>;
+    createJob(job: IJobRequest<T>): Promise<Observable<JobResponse<U>>>;
     /**
      * Get a job by ID.
      * @param id The ID of the job to get.
      * @returns The job.
      */
-    getJob(id: string): IJob;
+    getJob(id: string): IJobRequest<T>;
     /**
      * Get all jobs.
      * @returns All jobs.
      */
-    getJobs(): IJob[];
+    getJobs(): IJobRequest<T>[];
     /**
      * Close the Job Dispatcher.
      */

package/dist/job/JobWorkerConnector.d.ts

@@ -1,12 +1,17 @@
-import { IJob, IJobResult } from './Job';
+import { IJobParameters, IJobRequest, IJobResult, JobResponse } from './Job';
 /**
  * The Job Worker Connector interface.
  * @ignore
  */
-export interface IJobWorkerConnector {
+export interface IJobWorkerConnector<T extends IJobParameters, U extends IJobResult> {
     /**
      * Process a job.
      * @param job The job to process.
      */
-    processJob(job: IJob): AsyncGenerator<IJobResult>;
+    processJob(job: IJobRequest<T>): Promise<JobResponse<U>>;
+    /**
+     * Process a job stream.
+     * @param job The job to process.
+     */
+    processJobStream(job: IJobRequest<T>): AsyncGenerator<JobResponse<U>>;
 }

package/package.json

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