@crewdle/web-sdk-types 1.0.36 → 1.0.38

package/dist/core/sdk/SDK.d.ts

@@ -27,9 +27,10 @@ export interface ISDK {
     /**
      * Validate a key.
      * @param key The key to validate.
+     * @param origin The origin of the request.
      * @returns A promise that resolves with the vendor ID.
      */
-    validateKey(key: string): Promise<string>;
+    validateKey(key: string, origin?: string): Promise<string>;
     /**
      * Join a cluster.
      * @param clusterId The ID of the cluster to join.

package/dist/core/sdk/SDKOptions.d.ts

@@ -2,7 +2,7 @@ import { KeyValueDatabaseConnectorConstructor } from '../../key-value-database';
 import { ILoggingConnector } from '.';
 import { DocumentParserConnectorConstructor, ObjectStoreConnectorConstructor } from '../../object-storage';
 import { PeerConnectionConnectorConstructor } from '../connection';
-import { AISearchConnectorConstructor, GenerativeAIEngineType, GenerativeAIFileConnectorConstructor, GenerativeAIRagConnectorConstructor, GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor, QueryFileConnectorConstructor, SearchConnectorConstructor } from '../../generative-ai';
+import { AISearchConnectorConstructor, GenerativeAIEngineType, GenerativeAIFileConnectorConstructor, GenerativeAIRagConnectorConstructor, GenerativeAIRagType, GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor, QueryFileConnectorConstructor, SearchConnectorConstructor } from '../../generative-ai';
 import { VectorDatabaseConnectorConstructor } from '../../vector-database';
 import { GraphDatabaseConnectorConstructor } from '../../graph-database';
 import { ExternalStorageConnectionConnectorConstructor, ExternalStorageType } from '../../external-storage';
@@ -81,7 +81,7 @@ export interface ISDKOptions {
     /**
      * The custom RAG connector to use for RAG tasks.
      */
-    ragConnector?: GenerativeAIRagConnectorConstructor;
+    ragConnectors?: Map<GenerativeAIRagType, GenerativeAIRagConnectorConstructor>;
     /**
      * The maximum number of outgoing subscriptions.
      */

package/dist/generative-ai/GenerativeAIWorkerConnector.d.ts

@@ -62,7 +62,8 @@ export declare enum GenerativeAITaskType {
 export declare enum GenerativeAIEngineType {
     Llamacpp = "llamacpp",
     Transformers = "transformers",
-    OpenAI = "openai"
+    OpenAI = "openai",
+    Anthropic = "anthropic"
 }
 /**
  * The generative AI model interface.

package/dist/generative-ai/GenerativeAIWorkerConnector.js

@@ -63,4 +63,5 @@ export var GenerativeAIEngineType;
     GenerativeAIEngineType["Llamacpp"] = "llamacpp";
     GenerativeAIEngineType["Transformers"] = "transformers";
     GenerativeAIEngineType["OpenAI"] = "openai";
+    GenerativeAIEngineType["Anthropic"] = "anthropic";
 })(GenerativeAIEngineType || (GenerativeAIEngineType = {}));

package/dist/generative-ai/IIndex.d.ts

@@ -6,7 +6,7 @@ export interface IIndex {
     /**
      * The content of the index.
      */
-    content: string;
+    content: number[] | string;
     /**
      * The start index of the content.
      */

package/dist/generative-ai/jobs/inference/GenerativeAIInferenceWorkerParameters.d.ts

@@ -127,10 +127,26 @@ export interface IGenerativeAIInferenceTool {
      * The temperature for the tool.
      */
     temperature?: number;
+    /**
+     * The grammar for the tool.
+     */
+    grammar?: any;
     /**
      * The collection ID for the tool.
      */
     collectionId?: string;
+    /**
+     * The form skill questions for the tool.
+     */
+    questions?: IGenerativeAIInferenceQuestion[];
+    /**
+     * Whether to emit the tool call result.
+     */
+    shouldEmit?: boolean;
+    /**
+     * The tools for the tool.
+     */
+    tools?: IGenerativeAIInferenceTool[];
 }
 /**
  * The enum for the generative AI inference tool type.
@@ -148,7 +164,28 @@ export declare enum GenerativeAIInferenceToolType {
     Search = "search",
     WebScraper = "web-scraper",
     WebScraperRaw = "web-scraper-raw",
-    WriteFile = "write-file"
+    WriteFile = "write-file",
+    FormSkillGetQuestion = "form-skill-get-question",
+    FormSkillSetAnswer = "form-skill-set-answer",
+    FormSkillSubmitForm = "form-skill-submit-form"
+}
+/**
+ * The interface for the generative AI inference form skill question.
+ * @category AI
+ */
+export interface IGenerativeAIInferenceQuestion {
+    /**
+     * The question.
+     */
+    question: string;
+    /**
+     * The validation for the question.
+     */
+    validation: string;
+    /**
+     * Whether the question is required.
+     */
+    required: boolean;
 }
 /**
  * The interface for the generative AI inference tool parameter.

package/dist/generative-ai/jobs/inference/GenerativeAIInferenceWorkerParameters.js

@@ -16,4 +16,7 @@ export var GenerativeAIInferenceToolType;
     GenerativeAIInferenceToolType["WebScraper"] = "web-scraper";
     GenerativeAIInferenceToolType["WebScraperRaw"] = "web-scraper-raw";
     GenerativeAIInferenceToolType["WriteFile"] = "write-file";
+    GenerativeAIInferenceToolType["FormSkillGetQuestion"] = "form-skill-get-question";
+    GenerativeAIInferenceToolType["FormSkillSetAnswer"] = "form-skill-set-answer";
+    GenerativeAIInferenceToolType["FormSkillSubmitForm"] = "form-skill-submit-form";
 })(GenerativeAIInferenceToolType || (GenerativeAIInferenceToolType = {}));

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallCreateJobParameters.d.ts

@@ -14,6 +14,12 @@ export interface IGenerativeAIToolCallCreateJobParameters extends IGenerativeAIC
      * The tool to be processed.
      */
     tool: IGenerativeAIInferenceTool;
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * The arguments for the tool.
      */

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallJob.d.ts

@@ -15,6 +15,12 @@ export interface IGenerativeAIToolCallJob extends IGenerativeAIJob {
      * The tool to be processed.
      */
     tool: IGenerativeAIInferenceTool;
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * Runs the job.
      * @returns A promise that resolves with the result of the job.

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallResult.d.ts

@@ -13,4 +13,10 @@ export interface IGenerativeAIToolCallResult extends IGenerativeAIJobResult {
      * The output of the tool.
      */
     output: string;
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
 }

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallWorkerParameters.d.ts

@@ -14,6 +14,12 @@ export interface IGenerativeAIToolCallWorkerParameters extends IGenerativeAIWork
      * The tool to be processed.
      */
     tool: IGenerativeAIInferenceTool;
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * The arguments for the tool.
      */

package/dist/generative-ai/rag/GenerativeAIRagConnector.d.ts

@@ -1,5 +1,10 @@
+import { IIndex } from '../IIndex';
 import { IGenerativeAIFile } from '../jobs';
 import { ISearchResult } from '../search';
+export declare enum GenerativeAIRagType {
+    Pinecone = "pinecone",
+    Crewdle = "crewdle"
+}
 /**
  * Generative AI Rag Connector Interface
  * @category AI
@@ -7,42 +12,50 @@ import { ISearchResult } from '../search';
 export interface IGenerativeAIRagConnector {
     /**
      * Create a collection.
+     * @param instanceId The instance id to create the collection.
      * @param collectionId The collection id to create.
      * @returns A promise that resolves when the collection is created.
      */
-    createCollection(collectionId: string): Promise<void>;
+    createCollection(instanceId: string, collectionId: string): Promise<void>;
     /**
      * Delete a collection.
+     * @param instanceId The instance id to delete the collection.
      * @param collectionId The collection id to delete.
+     * @param deleteInstance Whether to delete the instance as well.
      * @returns A promise that resolves when the collection is deleted.
      */
-    deleteCollection(collectionId: string): Promise<void>;
+    deleteCollection(instanceId: string, collectionId: string, deleteInstance: boolean): Promise<void>;
     /**
      * Query a collection.
+     * @param instanceId The instance id to query.
      * @param collectionId The collection id to query.
      * @param query The query to run.
+     * @param topK The number of results to return.
      * @returns The search results.
      */
-    queryCollection(collectionId: string, query: string): Promise<ISearchResult[]>;
+    queryCollection(instanceId: string, collectionId: string, query: string | number[], topK: number): Promise<ISearchResult[]>;
     /**
      * Delete a file.
+     * @param instanceId The instance id of the file to delete.
      * @param collectionId The collection id of the file to delete.
      * @param fileId The file id to delete.
      * @returns A promise that resolves when the file is deleted.
      */
-    deleteFile(collectionId: string, fileId: string): Promise<void>;
+    deleteFile(instanceId: string, collectionId: string, fileId: string): Promise<void>;
     /**
      * Ingest a file.
+     * @param instanceId The instance id to ingest the file.
      * @param collectionId The collection id to ingest the file.
      * @param fileName The name of the file to ingest.
      * @param content The content of the file to ingest.
      * @returns A promise that resolves when the file is ingested.
      */
-    ingestFile(collectionId: string, fileName: string, content: string): Promise<void>;
+    ingestFile(instanceId: string, collectionId: string, fileName: string, content: string | IIndex[]): Promise<void>;
     /**
      * List files in a collection.
+     * @param instanceId The instance id to list files.
      * @param collectionId The collection id to list files.
      * @returns The list of files.
      */
-    listFiles(collectionId: string): Promise<IGenerativeAIFile[]>;
+    listFiles(instanceId: string, collectionId: string): Promise<IGenerativeAIFile[]>;
 }

package/dist/generative-ai/rag/GenerativeAIRagConnector.js

@@ -1 +1,5 @@
-export {};
+export var GenerativeAIRagType;
+(function (GenerativeAIRagType) {
+    GenerativeAIRagType["Pinecone"] = "pinecone";
+    GenerativeAIRagType["Crewdle"] = "crewdle";
+})(GenerativeAIRagType || (GenerativeAIRagType = {}));

package/dist/generative-ai/search/AISearchConnector.d.ts

@@ -6,8 +6,9 @@ export interface IAISearchConnector {
     /**
      * Searches for the query.
      * @param query The query to search for.
+     * @param modelId The model id to use for the search.
      * @param apiKey The API key to use for the search.
      * @returns A promise that resolves with the search result.
      */
-    search(query: string): Promise<string>;
+    search(query: string, modelId: string): Promise<string>;
 }

package/dist/generative-ai/search/SearchResult.d.ts

@@ -7,6 +7,14 @@ export interface ISearchResult {
      * The content of the search result.
      */
     content: string;
+    /**
+     * The start index of the search
+     */
+    start?: number;
+    /**
+     * The length of the search result.
+     */
+    length?: number;
     /**
      * The relevance of the search result.
      * The relevance is a number between 0 and 1, where 1 is the most relevant.

package/package.json

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