@crewdle/web-sdk-types 1.0.48 → 1.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryCreateJobParameters.d.ts +4 -0
  2. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryJob.d.ts +4 -0
  3. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryWorkerParameters.d.ts +4 -0
  4. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteCreateJobParameters.d.ts +4 -0
  5. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteJob.d.ts +4 -0
  6. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteWorkerParameters.d.ts +4 -0
  7. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestCreateJobParameters.d.ts +4 -0
  8. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestJob.d.ts +4 -0
  9. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestWorkerParameters.d.ts +4 -0
  10. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListCreateJobParameters.d.ts +4 -0
  11. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListJob.d.ts +4 -0
  12. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListWorkerParameters.d.ts +4 -0
  13. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceWorkerParameters.d.ts +4 -0
  14. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptCreateJobParameters.d.ts +4 -0
  15. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptJob.d.ts +4 -0
  16. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptWorkerParameters.d.ts +4 -0
  17. package/dist/generative-ai/rag/GenerativeAIRagConnector.d.ts +13 -12
  18. package/package.json +1 -1
@@ -17,4 +17,8 @@ export interface IGenerativeAICollectionQueryCreateJobParameters extends IGenera
17
17
  * The collection id for the search.
18
18
  */
19
19
  collectionId: string;
20
+ /**
21
+ * The namespace for the search.
22
+ */
23
+ namespace?: string;
20
24
  }
@@ -13,6 +13,10 @@ export interface IGenerativeAICollectionQueryJob extends IGenerativeAIJob {
13
13
  * The collection id for the search.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace for the search.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * Run the search job.
18
22
  * @returns A promise that resolves with the result.
@@ -17,4 +17,8 @@ export interface IGenerativeAICollectionQueryWorkerParameters extends IGenerativ
17
17
  * The collection id for the search.
18
18
  */
19
19
  collectionId: string;
20
+ /**
21
+ * The namespace for the search.
22
+ */
23
+ namespace?: string;
20
24
  }
@@ -13,6 +13,10 @@ export interface IGenerativeAIFileDeleteCreateJobParameters extends IGenerativeA
13
13
  * The collection id of the file to delete.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to delete the file.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * The file id of the file to delete.
18
22
  */
@@ -9,6 +9,10 @@ export interface IGenerativeAIFileDeleteJob extends IGenerativeAIJob {
9
9
  * The collection id of the file to delete.
10
10
  */
11
11
  collectionId: string;
12
+ /**
13
+ * The namespace to delete the file.
14
+ */
15
+ namespace?: string;
12
16
  /**
13
17
  * The file id of the file to delete.
14
18
  */
@@ -13,6 +13,10 @@ export interface IGenerativeAIFileDeleteWorkerParameters extends IGenerativeAIWo
13
13
  * The collection id of the file to delete.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to delete the file.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * The file id of the file to delete.
18
22
  */
@@ -13,6 +13,10 @@ export interface IGenerativeAIFileIngestCreateJobParameters extends IGenerativeA
13
13
  * The collection id of the file to ingest.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to ingest the file.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * The name of the file to ingest.
18
22
  */
@@ -9,6 +9,10 @@ export interface IGenerativeAIFileIngestJob extends IGenerativeAIJob {
9
9
  * The collection id of the file to ingest.
10
10
  */
11
11
  collectionId: string;
12
+ /**
13
+ * The namespace to ingest the file.
14
+ */
15
+ namespace?: string;
12
16
  /**
13
17
  * The name of the file to ingest.
14
18
  */
@@ -13,6 +13,10 @@ export interface IGenerativeAIFileIngestWorkerParameters extends IGenerativeAIWo
13
13
  * The collection id for the file to ingest.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to ingest the file.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * The name of the file to ingest.
18
22
  */
@@ -13,4 +13,8 @@ export interface IGenerativeAIFileListCreateJobParameters extends IGenerativeAIC
13
13
  * The collection id of the file to list.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to list files.
18
+ */
19
+ namespace?: string;
16
20
  }
@@ -9,6 +9,10 @@ export interface IGenerativeAIFileListJob extends IGenerativeAIJob {
9
9
  * The collection id of the file to list.
10
10
  */
11
11
  collectionId: string;
12
+ /**
13
+ * The namespace to list files.
14
+ */
15
+ namespace?: string;
12
16
  /**
13
17
  * Run the file list job.
14
18
  * @returns A promise that resolves with the result.
@@ -13,4 +13,8 @@ export interface IGenerativeAIFileListWorkerParameters extends IGenerativeAIWork
13
13
  * The collection id to list files from.
14
14
  */
15
15
  collectionId: string;
16
+ /**
17
+ * The namespace to list files.
18
+ */
19
+ namespace?: string;
16
20
  }
@@ -159,6 +159,10 @@ export interface IGenerativeAIInferenceTool {
159
159
  * The collection ID for the tool.
160
160
  */
161
161
  collectionId?: string;
162
+ /**
163
+ * The namespace for the tool.
164
+ */
165
+ namespace?: string;
162
166
  /**
163
167
  * The form skill questions for the tool.
164
168
  */
@@ -15,6 +15,10 @@ export interface IGenerativeAIPromptCreateJobParameters extends IGenerativeAICre
15
15
  * The workflow id to use for the prompt.
16
16
  */
17
17
  workflowId: string;
18
+ /**
19
+ * The namespace to use for the prompt.
20
+ */
21
+ namespace?: string;
18
22
  /**
19
23
  * The prompt to be processed.
20
24
  */
@@ -9,6 +9,10 @@ export interface IGenerativeAIPromptJob extends IGenerativeAIJob {
9
9
  * The workflow id to use for the prompt.
10
10
  */
11
11
  workflowId: string;
12
+ /**
13
+ * The namespace to use for the prompt.
14
+ */
15
+ namespace?: string;
12
16
  /**
13
17
  * The prompt to be processed
14
18
  */
@@ -13,6 +13,10 @@ export interface IGenerativeAIPromptWorkerParameters extends IGenerativeAIWorker
13
13
  * The workflow ID.
14
14
  */
15
15
  workflowId: string;
16
+ /**
17
+ * The namespace to use for the prompt.
18
+ */
19
+ namespace?: string;
16
20
  /**
17
21
  * The prompt for the AI job.
18
22
  */
@@ -5,6 +5,11 @@ export declare enum GenerativeAIRagType {
5
5
  Pinecone = "pinecone",
6
6
  Crewdle = "crewdle"
7
7
  }
8
+ export interface IGenerativeAIRagCollection {
9
+ instanceId: string;
10
+ collectionId: string;
11
+ namespace?: string;
12
+ }
8
13
  /**
9
14
  * Generative AI Rag Connector Interface
10
15
  * @category AI
@@ -27,35 +32,31 @@ export interface IGenerativeAIRagConnector {
27
32
  deleteCollection(instanceId: string, collectionId: string, deleteInstance: boolean): Promise<void>;
28
33
  /**
29
34
  * Query a collection.
30
- * @param instanceId The instance id to query.
31
- * @param collectionId The collection id to query.
35
+ * @param collection The collection to query.
32
36
  * @param query The query to run.
33
37
  * @param topK The number of results to return.
34
38
  * @returns The search results.
35
39
  */
36
- queryCollection(instanceId: string, collectionId: string, query: string | number[], topK: number): Promise<ISearchResult[]>;
40
+ queryCollection(collection: IGenerativeAIRagCollection, query: string | number[], topK: number): Promise<ISearchResult[]>;
37
41
  /**
38
42
  * Delete a file.
39
- * @param instanceId The instance id of the file to delete.
40
- * @param collectionId The collection id of the file to delete.
43
+ * @param collection The collection to delete the file.
41
44
  * @param fileId The file id to delete.
42
45
  * @returns A promise that resolves when the file is deleted.
43
46
  */
44
- deleteFile(instanceId: string, collectionId: string, fileId: string): Promise<void>;
47
+ deleteFile(collection: IGenerativeAIRagCollection, fileId: string): Promise<void>;
45
48
  /**
46
49
  * Ingest a file.
47
- * @param instanceId The instance id to ingest the file.
48
- * @param collectionId The collection id to ingest the file.
50
+ * @param collection The collection to ingest the file.
49
51
  * @param fileName The name of the file to ingest.
50
52
  * @param content The content of the file to ingest.
51
53
  * @returns A promise that resolves when the file is ingested.
52
54
  */
53
- ingestFile(instanceId: string, collectionId: string, fileName: string, content: string | IIndex[]): Promise<void>;
55
+ ingestFile(collection: IGenerativeAIRagCollection, fileName: string, content: string | IIndex[]): Promise<void>;
54
56
  /**
55
57
  * List files in a collection.
56
- * @param instanceId The instance id to list files.
57
- * @param collectionId The collection id to list files.
58
+ * @param collection The collection to list files.
58
59
  * @returns The list of files.
59
60
  */
60
- listFiles(instanceId: string, collectionId: string): Promise<IGenerativeAIFile[]>;
61
+ listFiles(collection: IGenerativeAIRagCollection): Promise<IGenerativeAIFile[]>;
61
62
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crewdle/web-sdk-types",
3
- "version": "1.0.48",
3
+ "version": "1.0.49",
4
4
  "description": "The Crewdle Mist Web SDK public types and interfaces",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",