@crewdle/web-sdk-types 1.0.33 → 1.0.35

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 (161) hide show
  1. package/dist/core/sdk/SDK.d.ts +6 -0
  2. package/dist/core/sdk/SDKOptions.d.ts +10 -6
  3. package/dist/generative-ai/GenerativeAIContext.d.ts +14 -23
  4. package/dist/generative-ai/GenerativeAIJobType.d.ts +41 -5
  5. package/dist/generative-ai/GenerativeAIWorkerConnector.d.ts +2 -1
  6. package/dist/generative-ai/GenerativeAIWorkerConnector.js +1 -0
  7. package/dist/generative-ai/GenerativeAIWorkerConnectorConstructor.d.ts +1 -1
  8. package/dist/generative-ai/file/GenerativeAIFileConnector.d.ts +13 -0
  9. package/dist/generative-ai/file/GenerativeAIFileConnectorConstructor.d.ts +5 -0
  10. package/dist/generative-ai/file/index.d.ts +2 -0
  11. package/dist/generative-ai/file/index.js +2 -0
  12. package/dist/generative-ai/index.d.ts +2 -0
  13. package/dist/generative-ai/index.js +2 -0
  14. package/dist/generative-ai/job/{JobParametersGenerativeAI.d.ts → GenerativeAIJobParameters.d.ts} +1 -1
  15. package/dist/generative-ai/job/{JobResultGenerativeAI.d.ts → GenerativeAIJobResult.d.ts} +1 -1
  16. package/dist/generative-ai/job/index.d.ts +2 -2
  17. package/dist/generative-ai/job/index.js +2 -2
  18. package/dist/generative-ai/jobs/collection-create/GenerativeAICollectionCreateCreateJobParameters.d.ts +16 -0
  19. package/dist/generative-ai/jobs/collection-create/GenerativeAICollectionCreateJob.d.ts +17 -0
  20. package/dist/generative-ai/jobs/collection-create/GenerativeAICollectionCreateResult.d.ts +13 -0
  21. package/dist/generative-ai/jobs/collection-create/GenerativeAICollectionCreateWorkerParameters.d.ts +16 -0
  22. package/dist/generative-ai/jobs/collection-create/index.d.ts +4 -0
  23. package/dist/generative-ai/jobs/collection-create/index.js +4 -0
  24. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteCreateJobParameters.d.ts +16 -0
  25. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteJob.d.ts +17 -0
  26. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteJob.js +1 -0
  27. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteResult.d.ts +13 -0
  28. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteResult.js +1 -0
  29. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteWorkerParameters.d.ts +16 -0
  30. package/dist/generative-ai/jobs/collection-delete/GenerativeAICollectionDeleteWorkerParameters.js +1 -0
  31. package/dist/generative-ai/jobs/collection-delete/index.d.ts +4 -0
  32. package/dist/generative-ai/jobs/collection-delete/index.js +4 -0
  33. package/dist/generative-ai/jobs/{search/GenerativeAISearchWorkerParameter.d.ts → collection-query/GenerativeAICollectionQueryCreateJobParameters.d.ts} +3 -3
  34. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryCreateJobParameters.js +1 -0
  35. package/dist/generative-ai/jobs/{search/GenerativeAISearchJob.d.ts → collection-query/GenerativeAICollectionQueryJob.d.ts} +3 -7
  36. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryJob.js +1 -0
  37. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryResult.d.ts +18 -0
  38. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryResult.js +1 -0
  39. package/dist/generative-ai/jobs/{search/GenerativeAISearchCreateJobParameters.d.ts → collection-query/GenerativeAICollectionQueryWorkerParameters.d.ts} +3 -3
  40. package/dist/generative-ai/jobs/collection-query/GenerativeAICollectionQueryWorkerParameters.js +1 -0
  41. package/dist/generative-ai/jobs/collection-query/index.d.ts +4 -0
  42. package/dist/generative-ai/jobs/collection-query/index.js +4 -0
  43. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedCreateJobParameters.d.ts +24 -0
  44. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedCreateJobParameters.js +1 -0
  45. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedJob.d.ts +21 -0
  46. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedJob.js +1 -0
  47. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedWorkerParameters.d.ts +20 -0
  48. package/dist/generative-ai/jobs/embed/GenerativeAIEmbedWorkerParameters.js +1 -0
  49. package/dist/generative-ai/jobs/embed/index.d.ts +3 -0
  50. package/dist/generative-ai/jobs/embed/index.js +3 -0
  51. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteCreateJobParameters.d.ts +20 -0
  52. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteCreateJobParameters.js +1 -0
  53. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteJob.d.ts +21 -0
  54. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteJob.js +1 -0
  55. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteResult.d.ts +13 -0
  56. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteResult.js +1 -0
  57. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteWorkerParameters.d.ts +20 -0
  58. package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteWorkerParameters.js +1 -0
  59. package/dist/generative-ai/jobs/file-delete/index.d.ts +4 -0
  60. package/dist/generative-ai/jobs/file-delete/index.js +4 -0
  61. package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentCreateJobParameters.d.ts → file-download/GenerativeAIFileDownloadCreateJobParameters.d.ts} +4 -4
  62. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadCreateJobParameters.js +1 -0
  63. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadJob.d.ts +21 -0
  64. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadJob.js +1 -0
  65. package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentResult.d.ts → file-download/GenerativeAIFileDownloadResult.d.ts} +3 -3
  66. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadResult.js +1 -0
  67. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadWorkerParameters.d.ts +20 -0
  68. package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadWorkerParameters.js +1 -0
  69. package/dist/generative-ai/jobs/file-download/index.d.ts +4 -0
  70. package/dist/generative-ai/jobs/file-download/index.js +4 -0
  71. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestCreateJobParameters.d.ts +24 -0
  72. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestCreateJobParameters.js +1 -0
  73. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestJob.d.ts +25 -0
  74. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestJob.js +1 -0
  75. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestResult.d.ts +13 -0
  76. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestResult.js +1 -0
  77. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestWorkerParameters.d.ts +24 -0
  78. package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestWorkerParameters.js +1 -0
  79. package/dist/generative-ai/jobs/file-ingest/index.d.ts +4 -0
  80. package/dist/generative-ai/jobs/file-ingest/index.js +4 -0
  81. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListCreateJobParameters.d.ts +16 -0
  82. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListCreateJobParameters.js +1 -0
  83. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListJob.d.ts +17 -0
  84. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListJob.js +1 -0
  85. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListResult.d.ts +36 -0
  86. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListResult.js +1 -0
  87. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListWorkerParameters.d.ts +16 -0
  88. package/dist/generative-ai/jobs/file-list/GenerativeAIFileListWorkerParameters.js +1 -0
  89. package/dist/generative-ai/jobs/file-list/index.d.ts +4 -0
  90. package/dist/generative-ai/jobs/file-list/index.js +4 -0
  91. package/dist/generative-ai/jobs/generic/GenerativeAICreateJobParameters.d.ts +4 -0
  92. package/dist/generative-ai/jobs/generic/GenerativeAIJob.d.ts +4 -0
  93. package/dist/generative-ai/jobs/generic/GenerativeAIWorkerParameters.d.ts +10 -2
  94. package/dist/generative-ai/jobs/index.d.ts +11 -2
  95. package/dist/generative-ai/jobs/index.js +11 -2
  96. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceCreateJobParameters.d.ts +60 -0
  97. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceCreateJobParameters.js +1 -0
  98. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceJob.d.ts +65 -0
  99. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceJob.js +1 -0
  100. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceWorkerParameters.d.ts +162 -0
  101. package/dist/generative-ai/jobs/inference/GenerativeAIInferenceWorkerParameters.js +19 -0
  102. package/dist/generative-ai/jobs/inference/index.d.ts +3 -0
  103. package/dist/generative-ai/jobs/inference/index.js +3 -0
  104. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptCreateJobParameters.d.ts +22 -3
  105. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptJob.d.ts +21 -3
  106. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptResult.d.ts +3 -3
  107. package/dist/generative-ai/jobs/prompt/GenerativeAIPromptWorkerParameters.d.ts +4 -0
  108. package/dist/generative-ai/jobs/rating/GenerativeAIRatingCreateJobParameters.d.ts +4 -0
  109. package/dist/generative-ai/jobs/rating/GenerativeAIRatingJob.d.ts +1 -5
  110. package/dist/generative-ai/jobs/rating/GenerativeAIRatingResult.d.ts +2 -2
  111. package/dist/generative-ai/jobs/rating/GenerativeAIRatingWorkerParameters.d.ts +4 -0
  112. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateCreateJobParameters.d.ts +16 -0
  113. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateCreateJobParameters.js +1 -0
  114. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateJob.d.ts +17 -0
  115. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateJob.js +1 -0
  116. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateResult.d.ts +41 -0
  117. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateResult.js +1 -0
  118. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateWorkerParameters.d.ts +16 -0
  119. package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateWorkerParameters.js +1 -0
  120. package/dist/generative-ai/jobs/realtime-session-create/index.d.ts +4 -0
  121. package/dist/generative-ai/jobs/realtime-session-create/index.js +4 -0
  122. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallCreateJobParameters.d.ts +23 -0
  123. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallCreateJobParameters.js +1 -0
  124. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallJob.d.ts +23 -0
  125. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallJob.js +1 -0
  126. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallResult.d.ts +16 -0
  127. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallResult.js +1 -0
  128. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallWorkerParameters.d.ts +23 -0
  129. package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallWorkerParameters.js +1 -0
  130. package/dist/generative-ai/jobs/tool-call/index.d.ts +4 -0
  131. package/dist/generative-ai/jobs/tool-call/index.js +4 -0
  132. package/dist/generative-ai/rag/GenerativeAIRagConnector.d.ts +48 -0
  133. package/dist/generative-ai/rag/GenerativeAIRagConnector.js +1 -0
  134. package/dist/generative-ai/rag/GenerativeAIRagConnectorConstructor.d.ts +5 -0
  135. package/dist/generative-ai/rag/GenerativeAIRagConnectorConstructor.js +1 -0
  136. package/dist/generative-ai/rag/index.d.ts +2 -0
  137. package/dist/generative-ai/rag/index.js +2 -0
  138. package/dist/generative-ai/search/AISearchConnector.d.ts +1 -1
  139. package/dist/generative-ai/search/AISearchConnectorConstructor.d.ts +1 -1
  140. package/dist/generative-ai/search/SearchConnector.d.ts +1 -1
  141. package/dist/generative-ai/search/SearchConnectorConstructor.d.ts +1 -1
  142. package/dist/generative-ai/union-types/CreateAIJobParameters.d.ts +4 -3
  143. package/dist/generative-ai/union-types/GenerativeAIJob.d.ts +4 -3
  144. package/dist/generative-ai/union-types/GenerativeAIJobResult.d.ts +10 -2
  145. package/dist/generative-ai/union-types/GenerativeAIWorkerParameters.d.ts +4 -3
  146. package/package.json +1 -1
  147. package/dist/generative-ai/jobs/download-document/GenerativeAIDownloadDocumentJob.d.ts +0 -25
  148. package/dist/generative-ai/jobs/download-document/GenerativeAIDownloadDocumentWorkerParameters.d.ts +0 -20
  149. package/dist/generative-ai/jobs/download-document/index.d.ts +0 -4
  150. package/dist/generative-ai/jobs/download-document/index.js +0 -4
  151. package/dist/generative-ai/jobs/search/index.d.ts +0 -3
  152. package/dist/generative-ai/jobs/search/index.js +0 -3
  153. /package/dist/generative-ai/{job/JobParametersGenerativeAI.js → file/GenerativeAIFileConnector.js} +0 -0
  154. /package/dist/generative-ai/{job/JobResultGenerativeAI.js → file/GenerativeAIFileConnectorConstructor.js} +0 -0
  155. /package/dist/generative-ai/{jobs/download-document/GenerativeAIDownloadDocumentCreateJobParameters.js → job/GenerativeAIJobParameters.js} +0 -0
  156. /package/dist/generative-ai/{jobs/download-document/GenerativeAIDownloadDocumentJob.js → job/GenerativeAIJobResult.js} +0 -0
  157. /package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentResult.js → collection-create/GenerativeAICollectionCreateCreateJobParameters.js} +0 -0
  158. /package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentWorkerParameters.js → collection-create/GenerativeAICollectionCreateJob.js} +0 -0
  159. /package/dist/generative-ai/jobs/{search/GenerativeAISearchCreateJobParameters.js → collection-create/GenerativeAICollectionCreateResult.js} +0 -0
  160. /package/dist/generative-ai/jobs/{search/GenerativeAISearchJob.js → collection-create/GenerativeAICollectionCreateWorkerParameters.js} +0 -0
  161. /package/dist/generative-ai/jobs/{search/GenerativeAISearchWorkerParameter.js → collection-delete/GenerativeAICollectionDeleteCreateJobParameters.js} +0 -0
@@ -24,6 +24,12 @@ export interface ISDK {
24
24
  * @returns A promise that resolves with the authenticated agent.
25
25
  */
26
26
  authenticateAgent(credentials: IAgentCredentials): Promise<IAuthAgent>;
27
+ /**
28
+ * Validate a key.
29
+ * @param key The key to validate.
30
+ * @returns A promise that resolves with the vendor ID.
31
+ */
32
+ validateKey(key: string): Promise<string>;
27
33
  /**
28
34
  * Join a cluster.
29
35
  * @param clusterId The ID of the cluster to join.
@@ -2,7 +2,7 @@ import { KeyValueDatabaseConnectorConstructor } from '../../key-value-database';
2
2
  import { ILoggingConnector } from '.';
3
3
  import { DocumentParserConnectorConstructor, ObjectStoreConnectorConstructor } from '../../object-storage';
4
4
  import { PeerConnectionConnectorConstructor } from '../connection';
5
- import { AISearchConnectorConstructor, GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor, QueryFileConnectorConstructor, SearchConnectorConstructor } from '../../generative-ai';
5
+ import { AISearchConnectorConstructor, GenerativeAIEngineType, GenerativeAIFileConnectorConstructor, GenerativeAIRagConnectorConstructor, GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor, QueryFileConnectorConstructor, SearchConnectorConstructor } from '../../generative-ai';
6
6
  import { VectorDatabaseConnectorConstructor } from '../../vector-database';
7
7
  import { GraphDatabaseConnectorConstructor } from '../../graph-database';
8
8
  import { ExternalStorageConnectionConnectorConstructor, ExternalStorageType } from '../../external-storage';
@@ -37,10 +37,6 @@ export interface ISDKOptions {
37
37
  * If not provided, the default key-value database connector is IndexedDB.
38
38
  */
39
39
  keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
40
- /**
41
- * The custom logging database connector to use for storing Job logs.
42
- */
43
- loggingDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
44
40
  /**
45
41
  * The custom peer connection connector to use for creating peer connections.
46
42
  * If not provided, the default peer connection connector is WebRTC in browser.
@@ -49,7 +45,7 @@ export interface ISDKOptions {
49
45
  /**
50
46
  * The custom generative AI worker connectors to use for generative AI tasks.
51
47
  */
52
- generativeAIWorkerConnectors?: GenerativeAIWorkerConnectorConstructor[];
48
+ generativeAIWorkerConnectors?: Map<GenerativeAIEngineType, GenerativeAIWorkerConnectorConstructor>;
53
49
  /**
54
50
  * The custom vector database connector to use for vector database tasks.
55
51
  */
@@ -62,6 +58,10 @@ export interface ISDKOptions {
62
58
  * The custom document parser connector to use for parsing documents.
63
59
  */
64
60
  documentParserConnector?: DocumentParserConnectorConstructor;
61
+ /**
62
+ * The custom file connector to use for file tasks.
63
+ */
64
+ fileConnector?: GenerativeAIFileConnectorConstructor;
65
65
  /**
66
66
  * The custom natural language processing connector to use for natural language processing tasks.
67
67
  */
@@ -78,6 +78,10 @@ export interface ISDKOptions {
78
78
  * The custom query file connector to use for querying files.
79
79
  */
80
80
  queryFileConnector?: QueryFileConnectorConstructor;
81
+ /**
82
+ * The custom RAG connector to use for RAG tasks.
83
+ */
84
+ ragConnector?: GenerativeAIRagConnectorConstructor;
81
85
  /**
82
86
  * The maximum number of outgoing subscriptions.
83
87
  */
@@ -1,8 +1,8 @@
1
- import { IGenerativeAIRatingResult, IGenerativeAIDownloadDocumentResult, ISearchResult } from '.';
2
- import { IGenerativeAIDownloadDocumentCreateJobParameters, IGenerativeAIDownloadDocumentJob } from './jobs/download-document';
1
+ import { IGenerativeAICollectionCreateCreateJobParameters, IGenerativeAICollectionCreateJob, IGenerativeAICollectionDeleteCreateJobParameters, IGenerativeAICollectionDeleteJob, IGenerativeAIEmbedCreateJobParameters, IGenerativeAIEmbedJob, IGenerativeAIFileDeleteCreateJobParameters, IGenerativeAIFileDeleteJob, IGenerativeAIFileIngestCreateJobParameters, IGenerativeAIFileIngestJob, IGenerativeAIFileListCreateJobParameters, IGenerativeAIFileListJob, IGenerativeAIInferenceCreateJobParameters, IGenerativeAIInferenceJob, IGenerativeAIRealtimeSessionCreateCreateJobParameters, IGenerativeAIRealtimeSessionCreateJob, IGenerativeAIToolCallCreateJobParameters, IGenerativeAIToolCallJob } from '.';
2
+ import { IGenerativeAIFileDownloadCreateJobParameters, IGenerativeAIFileDownloadJob } from './jobs/file-download';
3
3
  import { IGenerativeAIPromptCreateJobParameters, IGenerativeAIPromptJob } from './jobs/prompt';
4
4
  import { IGenerativeAIRatingCreateJobParameters, IGenerativeAIRatingJob } from './jobs/rating';
5
- import { IGenerativeAISearchCreateJobParameters, IGenerativeAISearchJob } from './jobs/search';
5
+ import { IGenerativeAICollectionQueryCreateJobParameters, IGenerativeAICollectionQueryJob } from './jobs/collection-query';
6
6
  /**
7
7
  * Represents a context for a Generative AI service.
8
8
  * @category AI
@@ -13,28 +13,19 @@ export interface IGenerativeAIContext {
13
13
  * @param parameters The parameters of the AI job.
14
14
  * @returns The job ready to be run or streamed.
15
15
  */
16
+ createAIJob(parameters: IGenerativeAICollectionCreateCreateJobParameters): IGenerativeAICollectionCreateJob;
17
+ createAIJob(parameters: IGenerativeAICollectionDeleteCreateJobParameters): IGenerativeAICollectionDeleteJob;
18
+ createAIJob(parameters: IGenerativeAICollectionQueryCreateJobParameters): IGenerativeAICollectionQueryJob;
19
+ createAIJob(parameters: IGenerativeAIEmbedCreateJobParameters): IGenerativeAIEmbedJob;
20
+ createAIJob(parameters: IGenerativeAIFileDeleteCreateJobParameters): IGenerativeAIFileDeleteJob;
21
+ createAIJob(parameters: IGenerativeAIFileDownloadCreateJobParameters): IGenerativeAIFileDownloadJob;
22
+ createAIJob(parameters: IGenerativeAIFileIngestCreateJobParameters): IGenerativeAIFileIngestJob;
23
+ createAIJob(parameters: IGenerativeAIFileListCreateJobParameters): IGenerativeAIFileListJob;
24
+ createAIJob(parameters: IGenerativeAIInferenceCreateJobParameters): IGenerativeAIInferenceJob;
16
25
  createAIJob(parameters: IGenerativeAIPromptCreateJobParameters): IGenerativeAIPromptJob;
17
26
  createAIJob(parameters: IGenerativeAIRatingCreateJobParameters): IGenerativeAIRatingJob;
18
- createAIJob(parameters: IGenerativeAIDownloadDocumentCreateJobParameters): IGenerativeAIDownloadDocumentJob;
19
- createAIJob(parameters: IGenerativeAISearchCreateJobParameters): IGenerativeAISearchJob;
20
- /**
21
- * Rate a prompt.
22
- * @param parameters The parameters of the rating job.
23
- * @returns A promise that resolves with the result.
24
- */
25
- ratePrompt(parameters: IGenerativeAIRatingCreateJobParameters): Promise<IGenerativeAIRatingResult>;
26
- /**
27
- * Download a document.
28
- * @param documentPath The path of the document to download.
29
- * @returns A promise that resolves with the result containing the document as an ArrayBuffer.
30
- */
31
- downloadDocument(documentPath: string): Promise<IGenerativeAIDownloadDocumentResult>;
32
- /**
33
- * Search for documents.
34
- * @param parameters The parameters of the search job.
35
- * @returns A promise that resolves with the result containing the search results.
36
- */
37
- search(parameters: IGenerativeAISearchCreateJobParameters): Promise<ISearchResult[]>;
27
+ createAIJob(parameters: IGenerativeAIRealtimeSessionCreateCreateJobParameters): IGenerativeAIRealtimeSessionCreateJob;
28
+ createAIJob(parameters: IGenerativeAIToolCallCreateJobParameters): IGenerativeAIToolCallJob;
38
29
  /**
39
30
  * Get the data bucket IDs.
40
31
  * @returns An array of data bucket IDs.
@@ -4,19 +4,55 @@
4
4
  */
5
5
  export declare const enum GenerativeAIJobType {
6
6
  /**
7
- * The AI job generates a prompt.
7
+ * The AI job creates a workflow.
8
8
  */
9
9
  Prompt = "prompt",
10
+ /**
11
+ * The AI job creates a collection.
12
+ */
13
+ CollectionCreate = "collection-create",
14
+ /**
15
+ * The AI job deletes a collection.
16
+ */
17
+ CollectionDelete = "collection-delete",
18
+ /**
19
+ * The AI job retrieves documents.
20
+ */
21
+ CollectionQuery = "collection-query",
22
+ /**
23
+ * The AI job runs embedding.
24
+ */
25
+ Embed = "embed",
26
+ /**
27
+ * The AI job deletes a file.
28
+ */
29
+ FileDelete = "file-delete",
30
+ /**
31
+ * The AI job downloads a file.
32
+ */
33
+ FileDownload = "file-download",
34
+ /**
35
+ * The AI job ingests a file.
36
+ */
37
+ FileIngest = "file-ingest",
38
+ /**
39
+ * The AI job lists files.
40
+ */
41
+ FileList = "file-list",
42
+ /**
43
+ * The AI job runs inference.
44
+ */
45
+ Inference = "inference",
10
46
  /**
11
47
  * The AI job rates a prompt.
12
48
  */
13
49
  Rating = "rate",
14
50
  /**
15
- * The user requests to download a document related to the answer they got.
51
+ * The AI job for real-time session create.
16
52
  */
17
- DownloadDocument = "downloadDocument",
53
+ RealtimeSessionCreate = "realtime-session-create",
18
54
  /**
19
- * The AI job retrieves documents.
55
+ * The AI job tool call.
20
56
  */
21
- Search = "search"
57
+ ToolCall = "tool-call"
22
58
  }
@@ -61,7 +61,8 @@ export declare enum GenerativeAITaskType {
61
61
  */
62
62
  export declare enum GenerativeAIEngineType {
63
63
  Llamacpp = "llamacpp",
64
- Transformers = "transformers"
64
+ Transformers = "transformers",
65
+ OpenAI = "openai"
65
66
  }
66
67
  /**
67
68
  * The generative AI model interface.
@@ -62,4 +62,5 @@ export var GenerativeAIEngineType;
62
62
  (function (GenerativeAIEngineType) {
63
63
  GenerativeAIEngineType["Llamacpp"] = "llamacpp";
64
64
  GenerativeAIEngineType["Transformers"] = "transformers";
65
+ GenerativeAIEngineType["OpenAI"] = "openai";
65
66
  })(GenerativeAIEngineType || (GenerativeAIEngineType = {}));
@@ -3,4 +3,4 @@ import { IGenerativeAIWorkerConnector } from '.';
3
3
  * The generative AI worker connector constructor type.
4
4
  * @category AI
5
5
  */
6
- export type GenerativeAIWorkerConnectorConstructor = new () => IGenerativeAIWorkerConnector;
6
+ export type GenerativeAIWorkerConnectorConstructor = new (apiKey?: string) => IGenerativeAIWorkerConnector;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Interface for a file connector.
3
+ */
4
+ export interface IGenerativeAIFileConnector {
5
+ /**
6
+ * Write a file.
7
+ */
8
+ writeFile(file: File): Promise<string>;
9
+ /**
10
+ * Delete a file.
11
+ */
12
+ deleteFile(fileId: string): Promise<void>;
13
+ }
@@ -0,0 +1,5 @@
1
+ import { IGenerativeAIFileConnector } from './GenerativeAIFileConnector';
2
+ /**
3
+ * The constructor for the GenerativeAI File Connector.
4
+ */
5
+ export type GenerativeAIFileConnectorConstructor = new (apiKey: string) => IGenerativeAIFileConnector;
@@ -0,0 +1,2 @@
1
+ export * from './GenerativeAIFileConnector';
2
+ export * from './GenerativeAIFileConnectorConstructor';
@@ -0,0 +1,2 @@
1
+ export * from './GenerativeAIFileConnector';
2
+ export * from './GenerativeAIFileConnectorConstructor';
@@ -1,6 +1,8 @@
1
+ export * from './file';
1
2
  export * from './job';
2
3
  export * from './jobs';
3
4
  export * from './query';
5
+ export * from './rag';
4
6
  export * from './search';
5
7
  export * from './union-types';
6
8
  export * from './GenerativeAIContext';
@@ -1,6 +1,8 @@
1
+ export * from './file';
1
2
  export * from './job';
2
3
  export * from './jobs';
3
4
  export * from './query';
5
+ export * from './rag';
4
6
  export * from './search';
5
7
  export * from './union-types';
6
8
  export * from './GenerativeAIContext';
@@ -7,7 +7,7 @@ import { IGenerativeAIRatingOptions } from '../jobs/rating/GenerativeAIRatingOpt
7
7
  * Parameters for AI job type.
8
8
  * @category AI
9
9
  */
10
- export interface IJobParametersGenerativeAI extends IJobParameters, IGenerativeAIPromptOptions, IGenerativeAIRatingOptions {
10
+ export interface IGenerativeAIJobParameters extends IJobParameters, IGenerativeAIPromptOptions, IGenerativeAIRatingOptions {
11
11
  /**
12
12
  * The AI job type.
13
13
  */
@@ -5,7 +5,7 @@ import { IJobResult } from '../../job/Job';
5
5
  * Represents the result of an AI job.
6
6
  * @category AI
7
7
  */
8
- export interface IJobResultGenerativeAI extends IJobResult {
8
+ export interface IGenerativeAIJobResult extends IJobResult {
9
9
  /**
10
10
  * The AI job type.
11
11
  */
@@ -1,2 +1,2 @@
1
- export * from './JobResultGenerativeAI';
2
- export * from './JobParametersGenerativeAI';
1
+ export * from './GenerativeAIJobResult';
2
+ export * from './GenerativeAIJobParameters';
@@ -1,2 +1,2 @@
1
- export * from './JobResultGenerativeAI';
2
- export * from './JobParametersGenerativeAI';
1
+ export * from './GenerativeAIJobResult';
2
+ export * from './GenerativeAIJobParameters';
@@ -0,0 +1,16 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAICreateJobParameters } from '../generic';
3
+ /**
4
+ * Represents the parameters to create a collection create job
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionCreateCreateJobParameters extends IGenerativeAICreateJobParameters {
8
+ /**
9
+ * The AI job type.
10
+ */
11
+ type: GenerativeAIJobType.CollectionCreate;
12
+ /**
13
+ * The collection id to create.
14
+ */
15
+ collectionId: string;
16
+ }
@@ -0,0 +1,17 @@
1
+ import { IGenerativeAIJob } from '../generic';
2
+ import { IGenerativeAICollectionCreateResult } from './GenerativeAICollectionCreateResult';
3
+ /**
4
+ * Represents bounded create collection job ready to be executed
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionCreateJob extends IGenerativeAIJob {
8
+ /**
9
+ * The collection id of the document to download.
10
+ */
11
+ collectionId: string;
12
+ /**
13
+ * Run the create collection job.
14
+ * @returns A promise that resolves with the result.
15
+ */
16
+ run: () => Promise<IGenerativeAICollectionCreateResult>;
17
+ }
@@ -0,0 +1,13 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
3
+ /**
4
+ * The AI collection create result Interface
5
+ * Represents the result of an AI collection create.
6
+ * @category AI
7
+ */
8
+ export interface IGenerativeAICollectionCreateResult extends IGenerativeAIJobResult {
9
+ /**
10
+ * The collection create AI job type.
11
+ */
12
+ type: GenerativeAIJobType.CollectionCreate;
13
+ }
@@ -0,0 +1,16 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAIWorkerParameters } from '../generic';
3
+ /**
4
+ * AI collection create job parameters Interface
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionCreateWorkerParameters extends IGenerativeAIWorkerParameters {
8
+ /**
9
+ * The AI job type.
10
+ */
11
+ type: GenerativeAIJobType.CollectionCreate;
12
+ /**
13
+ * The collection id to create.
14
+ */
15
+ collectionId: string;
16
+ }
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionCreateCreateJobParameters';
2
+ export * from './GenerativeAICollectionCreateJob';
3
+ export * from './GenerativeAICollectionCreateResult';
4
+ export * from './GenerativeAICollectionCreateWorkerParameters';
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionCreateCreateJobParameters';
2
+ export * from './GenerativeAICollectionCreateJob';
3
+ export * from './GenerativeAICollectionCreateResult';
4
+ export * from './GenerativeAICollectionCreateWorkerParameters';
@@ -0,0 +1,16 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAICreateJobParameters } from '../generic';
3
+ /**
4
+ * Represents the parameters to create a collection delete job
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionDeleteCreateJobParameters extends IGenerativeAICreateJobParameters {
8
+ /**
9
+ * The AI job type.
10
+ */
11
+ type: GenerativeAIJobType.CollectionDelete;
12
+ /**
13
+ * The collection id to delete.
14
+ */
15
+ collectionId: string;
16
+ }
@@ -0,0 +1,17 @@
1
+ import { IGenerativeAIJob } from '../generic';
2
+ import { IGenerativeAICollectionDeleteResult } from './GenerativeAICollectionDeleteResult';
3
+ /**
4
+ * Represents bounded delete collection job ready to be executed
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionDeleteJob extends IGenerativeAIJob {
8
+ /**
9
+ * The collection id to delete.
10
+ */
11
+ collectionId: string;
12
+ /**
13
+ * Run the delete collection job.
14
+ * @returns A promise that resolves with the result.
15
+ */
16
+ run: () => Promise<IGenerativeAICollectionDeleteResult>;
17
+ }
@@ -0,0 +1,13 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
3
+ /**
4
+ * The AI collection delete result Interface
5
+ * Represents the result of an AI collection delete.
6
+ * @category AI
7
+ */
8
+ export interface IGenerativeAICollectionDeleteResult extends IGenerativeAIJobResult {
9
+ /**
10
+ * The collection delete AI job type.
11
+ */
12
+ type: GenerativeAIJobType.CollectionDelete;
13
+ }
@@ -0,0 +1,16 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAIWorkerParameters } from '../generic';
3
+ /**
4
+ * Represents the parameters to delete a collection
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAICollectionDeleteWorkerParameters extends IGenerativeAIWorkerParameters {
8
+ /**
9
+ * The AI job type.
10
+ */
11
+ type: GenerativeAIJobType.CollectionDelete;
12
+ /**
13
+ * The collection id to delete.
14
+ */
15
+ collectionId: string;
16
+ }
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionDeleteCreateJobParameters';
2
+ export * from './GenerativeAICollectionDeleteJob';
3
+ export * from './GenerativeAICollectionDeleteResult';
4
+ export * from './GenerativeAICollectionDeleteWorkerParameters';
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionDeleteCreateJobParameters';
2
+ export * from './GenerativeAICollectionDeleteJob';
3
+ export * from './GenerativeAICollectionDeleteResult';
4
+ export * from './GenerativeAICollectionDeleteWorkerParameters';
@@ -1,14 +1,14 @@
1
1
  import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
- import { IGenerativeAIWorkerParameters } from '../generic/GenerativeAIWorkerParameters';
2
+ import { IGenerativeAICreateJobParameters } from '../generic';
3
3
  /**
4
4
  * AI search job parameters Interface
5
5
  * @category AI
6
6
  */
7
- export interface IGenerativeAISearchWorkerParameters extends IGenerativeAIWorkerParameters {
7
+ export interface IGenerativeAICollectionQueryCreateJobParameters extends IGenerativeAICreateJobParameters {
8
8
  /**
9
9
  * The AI job type.
10
10
  */
11
- type: GenerativeAIJobType.Search;
11
+ type: GenerativeAIJobType.CollectionQuery;
12
12
  /**
13
13
  * The query for the search.
14
14
  */
@@ -1,14 +1,10 @@
1
- import { ISearchResult } from '../../search';
2
1
  import { IGenerativeAIJob } from '../generic';
2
+ import { IGenerativeAICollectionQueryResult } from './GenerativeAICollectionQueryResult';
3
3
  /**
4
4
  * AI search job Interface
5
5
  * @category AI
6
6
  */
7
- export interface IGenerativeAISearchJob extends IGenerativeAIJob {
8
- /**
9
- * The job ID.
10
- */
11
- id: string;
7
+ export interface IGenerativeAICollectionQueryJob extends IGenerativeAIJob {
12
8
  /**
13
9
  * The query for the search.
14
10
  */
@@ -21,5 +17,5 @@ export interface IGenerativeAISearchJob extends IGenerativeAIJob {
21
17
  * Run the search job.
22
18
  * @returns A promise that resolves with the result.
23
19
  */
24
- search: () => Promise<ISearchResult[]>;
20
+ run: () => Promise<IGenerativeAICollectionQueryResult>;
25
21
  }
@@ -0,0 +1,18 @@
1
+ import { ISearchResult } from '../../search';
2
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
3
+ import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
4
+ /**
5
+ * The AI collection query result Interface
6
+ * Represents the result of an AI collection query.
7
+ * @category AI
8
+ */
9
+ export interface IGenerativeAICollectionQueryResult extends IGenerativeAIJobResult {
10
+ /**
11
+ * The collection delete AI job type.
12
+ */
13
+ type: GenerativeAIJobType.CollectionQuery;
14
+ /**
15
+ * The search result.
16
+ */
17
+ results: ISearchResult[];
18
+ }
@@ -1,14 +1,14 @@
1
1
  import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
- import { IGenerativeAICreateJobParameters } from '../generic/GenerativeAICreateJobParameters';
2
+ import { IGenerativeAIWorkerParameters } from '../generic';
3
3
  /**
4
4
  * AI search job parameters Interface
5
5
  * @category AI
6
6
  */
7
- export interface IGenerativeAISearchCreateJobParameters extends IGenerativeAICreateJobParameters {
7
+ export interface IGenerativeAICollectionQueryWorkerParameters extends IGenerativeAIWorkerParameters {
8
8
  /**
9
9
  * The AI job type.
10
10
  */
11
- type: GenerativeAIJobType.Search;
11
+ type: GenerativeAIJobType.CollectionQuery;
12
12
  /**
13
13
  * The query for the search.
14
14
  */
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionQueryCreateJobParameters';
2
+ export * from './GenerativeAICollectionQueryJob';
3
+ export * from './GenerativeAICollectionQueryResult';
4
+ export * from './GenerativeAICollectionQueryWorkerParameters';
@@ -0,0 +1,4 @@
1
+ export * from './GenerativeAICollectionQueryCreateJobParameters';
2
+ export * from './GenerativeAICollectionQueryJob';
3
+ export * from './GenerativeAICollectionQueryResult';
4
+ export * from './GenerativeAICollectionQueryWorkerParameters';
@@ -0,0 +1,24 @@
1
+ import { GenerativeAIJobType } from '../../GenerativeAIJobType';
2
+ import { IGenerativeAICreateJobParameters } from '../generic';
3
+ /**
4
+ * Represents the parameters for creating a new generative AI job for embedding.
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAIEmbedCreateJobParameters extends IGenerativeAICreateJobParameters {
8
+ /**
9
+ * The AI job type.
10
+ */
11
+ type: GenerativeAIJobType.Embed;
12
+ /**
13
+ * The model to use for embedding.
14
+ */
15
+ model: string;
16
+ /**
17
+ * The input text to embed.
18
+ */
19
+ text: string;
20
+ /**
21
+ * The thread ID for the job.
22
+ */
23
+ threadId: string;
24
+ }
@@ -0,0 +1,21 @@
1
+ import { IGenerativeAIJob } from '../generic';
2
+ import { IGenerativeAIPromptResult } from '../prompt';
3
+ /**
4
+ * Represents a job that embeds a given input into a latent space.
5
+ * @category AI
6
+ */
7
+ export interface IGenerativeAIEmbedJob extends IGenerativeAIJob {
8
+ /**
9
+ * The model used to embed the input text.
10
+ */
11
+ model: string;
12
+ /**
13
+ * The input text to embed.
14
+ */
15
+ text: string;
16
+ /**
17
+ * Run the embed job.
18
+ * @returns A promise that resolves with the result.
19
+ */
20
+ run: () => Promise<IGenerativeAIPromptResult>;
21
+ }