@crewdle/web-sdk-types 1.0.23 → 1.0.24

package/dist/generative-ai/union-types/GenerativeAIJob.d.ts

@@ -0,0 +1,8 @@
+import { IGenerativeAIDownloadDocumentJob } from '../jobs/download-document';
+import { IGenerativeAIPromptJob } from '../jobs/prompt';
+import { IGenerativeAIRatingJob } from '../jobs/rating';
+/**
+ * Represents a Generative AI job.
+ * @category AI
+ */
+export type GenerativeAIJob = IGenerativeAIPromptJob | IGenerativeAIRatingJob | IGenerativeAIDownloadDocumentJob;

package/dist/generative-ai/union-types/GenerativeAIJob.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/GenerativeAIJobOptions.d.ts

@@ -0,0 +1,7 @@
+import { IGenerativeAIPromptOptions } from '../jobs/prompt';
+import { IGenerativeAIRatingOptions } from '../jobs/rating';
+/**
+ * The AI options to parameterize the AI job.
+ * @category AI
+ */
+export type GenerativeAIJobOptions = IGenerativeAIPromptOptions | IGenerativeAIRatingOptions;

package/dist/generative-ai/union-types/GenerativeAIJobOptions.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/GenerativeAIJobResult.d.ts

@@ -0,0 +1,9 @@
+import { IGenerativeAIDownloadDocumentResult } from '../jobs/download-document';
+import { IGenerativeAIPromptResult } from '../jobs/prompt';
+import { IGenerativeAIRatingResult } from '../jobs/rating';
+/**
+ * Union type for an AI job result.
+ * Represents the result of an AI job.
+ * @category AI
+ */
+export type GenerativeAIJobResult = IGenerativeAIPromptResult | IGenerativeAIRatingResult | IGenerativeAIDownloadDocumentResult;

package/dist/generative-ai/union-types/GenerativeAIJobResult.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/GenerativeAIWorkerConnectorParameters.d.ts

@@ -0,0 +1,6 @@
+import { IGenerativeAIPromptWorkerConnectorParameters } from '../jobs/prompt/GenerativeAIPromptWorkerConnectorParameters';
+/**
+ * Union type for AI worker connector parameters.
+ * @category AI
+ */
+export type GenerativeAIWorkerConnectorParameters = IGenerativeAIPromptWorkerConnectorParameters;

package/dist/generative-ai/union-types/GenerativeAIWorkerConnectorParameters.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/GenerativeAIWorkerConnectorResult.d.ts

@@ -0,0 +1,12 @@
+import { IGenerativeAIWorkerConnectorPromptResult } from '../jobs/prompt';
+/**
+ * Union type for AI worker connector result.
+ * @category AI
+ */
+export type GenerativeAIWorkerConnectorResult = IGenerativeAIWorkerConnectorPromptResult;
+/**
+ * Helper type for AI worker connector result enum type.
+ * This is required in connectors that cannot import the AIJobType enum.
+ * @category AI
+ */
+export type GenerativeAIWorkerConnectorTypes = GenerativeAIWorkerConnectorResult['type'];

package/dist/generative-ai/union-types/GenerativeAIWorkerConnectorResult.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/GenerativeAIWorkerParameters.d.ts

@@ -0,0 +1,8 @@
+import { IGenerativeAIDownloadDocumentWorkerParameters } from '../jobs/download-document';
+import { IGenerativeAIPromptWorkerParameters } from '../jobs/prompt';
+import { IGenerativeAIRatingWorkerParameters } from '../jobs/rating';
+/**
+ * Union type for AI job worker parameters.
+ * @category AI
+ */
+export type GenerativeAIWorkerParameters = IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters | IGenerativeAIDownloadDocumentWorkerParameters;

package/dist/generative-ai/union-types/GenerativeAIWorkerParameters.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/union-types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './CreateAIJobParameters';
+export * from './GenerativeAIJob';
+export * from './GenerativeAIJobOptions';
+export * from './GenerativeAIJobResult';
+export * from './GenerativeAIWorkerConnectorResult';
+export * from './GenerativeAIWorkerConnectorParameters';
+export * from './GenerativeAIWorkerParameters';

package/dist/generative-ai/union-types/index.js

@@ -0,0 +1,7 @@
+export * from './CreateAIJobParameters';
+export * from './GenerativeAIJob';
+export * from './GenerativeAIJobOptions';
+export * from './GenerativeAIJobResult';
+export * from './GenerativeAIWorkerConnectorResult';
+export * from './GenerativeAIWorkerConnectorParameters';
+export * from './GenerativeAIWorkerParameters';

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

@@ -1,4 +1,4 @@
-import { IIndex } from '../ai';
+import { IIndex } from '../generative-ai';
 import { IDataStream } from '../core';
 /**
  * The interface for the graph database.

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

@@ -1,4 +1,4 @@
-import { IIndex } from '../ai';
+import { IIndex } from '../generative-ai';
 /**
  * The graph database connector interface.
  * @category Connector

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './media-stream';
 export * from './object-storage';
 export * from './pubsub';
 export * from './job';
-export * from './ai';
+export * from './generative-ai';
 export * from './vector-database';
 export * from './graph-database';
+export * from './external-storage';

package/dist/index.js

@@ -4,6 +4,7 @@ export * from './media-stream';
 export * from './object-storage';
 export * from './pubsub';
 export * from './job';
-export * from './ai';
+export * from './generative-ai';
 export * from './vector-database';
 export * from './graph-database';
+export * from './external-storage';

package/dist/object-storage/ObjectStoreBucket.d.ts

@@ -52,7 +52,7 @@ export interface IObjectStoreBucket extends IDataStream {
     /**
      * List the objects and folders of the bucket.
      * @param path The path of the folder.
-     * @param recursive Whether to list the objects and folders recursively.
+     * @param options The optional options for listing the objects and folders.
      * @returns The list of objects and folders.
      */
     list(path: string, options?: IObjectStoreListOptions): Promise<ObjectDescriptor[]>;

package/dist/vector-database/VectorDatabase.d.ts

@@ -1,4 +1,4 @@
-import { IIndex, ISearchResult } from '../ai';
+import { IIndex, ISearchResult } from '../generative-ai';
 import { IDataStream } from '../core';
 /**
  * The interface for the vector database.

package/dist/vector-database/VectorDatabaseConnector.d.ts

@@ -1,4 +1,4 @@
-import { IIndex, ISearchResult } from '../ai';
+import { IIndex, ISearchResult } from '../generative-ai';
 /**
  * The vector database connector interface.
  * @category Connector

package/package.json

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

package/dist/ai/GenerativeAI.d.ts

@@ -1,328 +0,0 @@
-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
- */
-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.
- * @category AI
- */
-export interface IPromptHistory {
-    /**
-     * The source of the prompt.
-     */
-    source: PromptSource;
-    /**
-     * The prompt.
-     */
-    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.
- * @category AI
- */
-export interface IPromptFunctionParams {
-    [key: string]: {
-        type: PromptFunctionParamsType;
-    };
-}
-/**
- * The AI prompt function Interface
- * Represents a function that can be called by the LLM.
- * @category AI
- */
-export interface IPromptFunction {
-    /**
-     * The function description.
-     */
-    description: string;
-    /**
-     * The function parameters.
-     */
-    params?: IPromptFunctionParams;
-    /**
-     * The function callback.
-     */
-    callback: (params?: {
-        [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 extends IAIOptions {
-    /**
-     * The instructions for the AI job.
-     */
-    instructions?: string;
-    /**
-     * The context for the AI job.
-     */
-    history?: IPromptHistory[];
-    /**
-     * The maximum number of tokens to generate.
-     */
-    maxTokens?: number;
-    /**
-     * The temperature for the LLM.
-     */
-    temperature?: number;
-    /**
-     * The functions that can be called by the LLM.
-     */
-    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
- */
-export type PromptTypeText = string | string[];
-/**
- * The AI prompt type vector
- */
-export type PromptTypeVector = number[];
-/**
- * The AI prompt result Interface
- * Represents the result of an AI prompt.
- * @category AI
- */
-export interface IGenerativeAIPromptResult extends IJobResultAI {
-    /**
-     * The prompt AI job type.
-     */
-    type: AIJobType.Prompt;
-    /**
-     * The output of the AI job.
-     */
-    output?: PromptTypeText | PromptTypeVector;
-    /**
-     * The relevant context used by the AI job.
-     */
-    context?: ISearchResult[];
-    /**
-     * The tokens used by the AI job.
-     */
-    inputTokens?: number;
-    /**
-     * The tokens generated by the AI job.
-     */
-    outputTokens?: number;
-}
-/**
- * The AI rating status Enum
- * @category AI
- */
-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 rating AI job type.
-     */
-    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 {
-    /**
-     * 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
- */
-export interface ISearchResult {
-    /**
-     * The content of the search result.
-     */
-    content: string;
-    /**
-     * The relevance of the search result.
-     * The relevance is a number between 0 and 1, where 1 is the most relevant.
-     */
-    relevance: number;
-    /**
-     * The path name of the document containing the search result.
-     */
-    pathName: string;
-}
-/**
- * Represents a content index.
- * @category AI
- */
-export interface IIndex {
-    /**
-     * The content of the index.
-     */
-    content: string;
-    /**
-     * The start index of the content.
-     */
-    start: number;
-    /**
-     * The length of the content.
-     */
-    length: number;
-}

package/dist/ai/GenerativeAI.js

@@ -1,53 +0,0 @@
-/**
- * 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
- */
-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 = {}));
-;
-;
-/**
- * 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,132 +0,0 @@
-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 {
-    /**
-     * 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.
-     */
-    createAIJob(parameters: IGenerativeAIPromptParameters): IGenerativeAIPromptJob;
-    createAIJob(parameters: IGenerativeAIRatingParameters): IGenerativeAIRatingJob;
-    /**
-     * Rate a prompt.
-     * @param parameters The parameters of the rating job.
-     * @returns A promise that resolves with the result.
-     */
-    ratePrompt(parameters: IGenerativeAIRatingParameters): Promise<IGenerativeAIRatingResult>;
-    /**
-     * Get the data bucket IDs.
-     * @returns An array of data bucket IDs.
-     */
-    getDataBucketIds(): Promise<string[]>;
-    /**
-     * Close the Generative AI Context.
-     */
-    close(): void;
-}