@crewdle/web-sdk-types 1.0.33 → 1.0.34

package/dist/generative-ai/jobs/embed/GenerativeAIEmbedWorkerParameters.d.ts

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * Parameters for the Embed worker.
+ * @category AI
+ */
+export interface IGenerativeAIEmbedWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Embed;
+    /**
+     * The model to use for embedding.
+     */
+    model: string;
+    /**
+     * The input text to embed.
+     */
+    text: string;
+}

package/dist/generative-ai/jobs/embed/GenerativeAIEmbedWorkerParameters.js

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

package/dist/generative-ai/jobs/embed/index.d.ts

@@ -0,0 +1,3 @@
+export * from './GenerativeAIEmbedCreateJobParameters';
+export * from './GenerativeAIEmbedJob';
+export * from './GenerativeAIEmbedWorkerParameters';

package/dist/generative-ai/jobs/embed/index.js

@@ -0,0 +1,3 @@
+export * from './GenerativeAIEmbedCreateJobParameters';
+export * from './GenerativeAIEmbedJob';
+export * from './GenerativeAIEmbedWorkerParameters';

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteCreateJobParameters.d.ts

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+/**
+ * Represents the parameters to create a delete file job
+ * @category AI
+ */
+export interface IGenerativeAIFileDeleteCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileDelete;
+    /**
+     * The collection id of the file to delete.
+     */
+    collectionId: string;
+    /**
+     * The file id of the file to delete.
+     */
+    fileId: string;
+}

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteCreateJobParameters.js

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

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteJob.d.ts

@@ -0,0 +1,21 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIFileDeleteResult } from './GenerativeAIFileDeleteResult';
+/**
+ * Represents bounded delete file job ready to be executed
+ * @category AI
+ */
+export interface IGenerativeAIFileDeleteJob extends IGenerativeAIJob {
+    /**
+     * The collection id of the file to delete.
+     */
+    collectionId: string;
+    /**
+     * The file id of the file to delete.
+     */
+    fileId: string;
+    /**
+     * Run the delete file job.
+     * @returns A promise that resolves with the result.
+     */
+    run: () => Promise<IGenerativeAIFileDeleteResult>;
+}

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteJob.js

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

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteResult.d.ts

@@ -0,0 +1,13 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
+/**
+ * The AI file delete result Interface
+ * Represents the result of an AI file delete.
+ * @category AI
+ */
+export interface IGenerativeAIFileDeleteResult extends IGenerativeAIJobResult {
+    /**
+     * The file delete AI job type.
+     */
+    type: GenerativeAIJobType.FileDelete;
+}

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteResult.js

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

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteWorkerParameters.d.ts

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * Parameters for the File Delete worker.
+ * @category AI
+ */
+export interface IGenerativeAIFileDeleteWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileDelete;
+    /**
+     * The collection id of the file to delete.
+     */
+    collectionId: string;
+    /**
+     * The file id of the file to delete.
+     */
+    fileId: string;
+}

package/dist/generative-ai/jobs/file-delete/GenerativeAIFileDeleteWorkerParameters.js

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

package/dist/generative-ai/jobs/file-delete/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileDeleteCreateJobParameters';
+export * from './GenerativeAIFileDeleteJob';
+export * from './GenerativeAIFileDeleteResult';
+export * from './GenerativeAIFileDeleteWorkerParameters';

package/dist/generative-ai/jobs/file-delete/index.js

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileDeleteCreateJobParameters';
+export * from './GenerativeAIFileDeleteJob';
+export * from './GenerativeAIFileDeleteResult';
+export * from './GenerativeAIFileDeleteWorkerParameters';

package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentCreateJobParameters.d.ts → file-download/GenerativeAIFileDownloadCreateJobParameters.d.ts}

@@ -4,15 +4,15 @@ import { IGenerativeAICreateJobParameters } from '../generic';
  * Represents the parameters to create a download document job
  * @category AI
  */
-export interface IGenerativeAIDownloadDocumentCreateJobParameters extends IGenerativeAICreateJobParameters {
+export interface IGenerativeAIFileDownloadCreateJobParameters extends IGenerativeAICreateJobParameters {
     /**
      * The AI job type.
      */
-    type: GenerativeAIJobType.DownloadDocument;
+    type: GenerativeAIJobType.FileDownload;
     /**
-     * The object store id of the document to download.
+     * The collection id of the document to download.
      */
-    objectStoreId: string;
+    collectionId: string;
     /**
      * The path of the document to download.
      */

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadCreateJobParameters.js

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

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadJob.d.ts

@@ -0,0 +1,21 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIFileDownloadResult } from './GenerativeAIFileDownloadResult';
+/**
+ * Represents bounded download document job ready to be executed.
+ * @category AI
+ */
+export interface IGenerativeAIFileDownloadJob extends IGenerativeAIJob {
+    /**
+     * The collection id of the document to download.
+     */
+    collectionId: string;
+    /**
+     * The path of the document to download.
+     */
+    documentPath: string;
+    /**
+     * Run the download document job.
+     * @returns A promise that resolves with the result.
+     */
+    run: () => Promise<IGenerativeAIFileDownloadResult>;
+}

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadJob.js

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

package/dist/generative-ai/jobs/{download-document/GenerativeAIDownloadDocumentResult.d.ts → file-download/GenerativeAIFileDownloadResult.d.ts}

@@ -1,14 +1,14 @@
 import { GenerativeAIJobType } from '../../GenerativeAIJobType';
-import { IJobResultGenerativeAI } from '../../job/JobResultGenerativeAI';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
 /**
  * The AI download document result Interface
  * @category AI
  */
-export interface IGenerativeAIDownloadDocumentResult extends IJobResultGenerativeAI {
+export interface IGenerativeAIFileDownloadResult extends IGenerativeAIJobResult {
     /**
      * The download document AI job type.
      */
-    type: GenerativeAIJobType.DownloadDocument;
+    type: GenerativeAIJobType.FileDownload;
     /**
      * The original file name.
      */

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadResult.js

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

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadWorkerParameters.d.ts

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * AI download document job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAIFileDownloadWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileDownload;
+    /**
+     * The collection id of the document to download.
+     */
+    collectionId: string;
+    /**
+     * The path of the document to download.
+     */
+    documentPath: string;
+}

package/dist/generative-ai/jobs/file-download/GenerativeAIFileDownloadWorkerParameters.js

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

package/dist/generative-ai/jobs/file-download/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileDownloadCreateJobParameters';
+export * from './GenerativeAIFileDownloadJob';
+export * from './GenerativeAIFileDownloadWorkerParameters';
+export * from './GenerativeAIFileDownloadResult';

package/dist/generative-ai/jobs/file-download/index.js

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileDownloadCreateJobParameters';
+export * from './GenerativeAIFileDownloadJob';
+export * from './GenerativeAIFileDownloadWorkerParameters';
+export * from './GenerativeAIFileDownloadResult';

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestCreateJobParameters.d.ts

@@ -0,0 +1,24 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+/**
+ * Represents the parameters to create a file ingest job
+ * @category AI
+ */
+export interface IGenerativeAIFileIngestCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileIngest;
+    /**
+     * The collection id of the file to ingest.
+     */
+    collectionId: string;
+    /**
+     * The name of the file to ingest.
+     */
+    fileName: string;
+    /**
+     * The file content to ingest.
+     */
+    content: string;
+}

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestCreateJobParameters.js

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

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestJob.d.ts

@@ -0,0 +1,25 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIFileIngestResult } from './GenerativeAIFileIngestResult';
+/**
+ * Represents bounded file ingest job ready to be executed
+ * @category AI
+ */
+export interface IGenerativeAIFileIngestJob extends IGenerativeAIJob {
+    /**
+     * The collection id of the file to ingest.
+     */
+    collectionId: string;
+    /**
+     * The name of the file to ingest.
+     */
+    fileName: string;
+    /**
+     * The file content to ingest.
+     */
+    content: string;
+    /**
+     * Run the file ingest job.
+     * @returns A promise that resolves with the result.
+     */
+    run: () => Promise<IGenerativeAIFileIngestResult>;
+}

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestJob.js

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

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestResult.d.ts

@@ -0,0 +1,13 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
+/**
+ * The AI file ingest result Interface
+ * Represents the result of an AI file ingest.
+ * @category AI
+ */
+export interface IGenerativeAIFileIngestResult extends IGenerativeAIJobResult {
+    /**
+     * The file ingest AI job type.
+     */
+    type: GenerativeAIJobType.FileIngest;
+}

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestResult.js

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

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestWorkerParameters.d.ts

@@ -0,0 +1,24 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * Parameters for the File Ingest worker.
+ * @category AI
+ */
+export interface IGenerativeAIFileIngestWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileIngest;
+    /**
+     * The collection id for the file to ingest.
+     */
+    collectionId: string;
+    /**
+     * The name of the file to ingest.
+     */
+    fileName: string;
+    /**
+     * The file content to ingest.
+     */
+    content: string;
+}

package/dist/generative-ai/jobs/file-ingest/GenerativeAIFileIngestWorkerParameters.js

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

package/dist/generative-ai/jobs/file-ingest/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileIngestCreateJobParameters';
+export * from './GenerativeAIFileIngestJob';
+export * from './GenerativeAIFileIngestResult';
+export * from './GenerativeAIFileIngestWorkerParameters';

package/dist/generative-ai/jobs/file-ingest/index.js

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileIngestCreateJobParameters';
+export * from './GenerativeAIFileIngestJob';
+export * from './GenerativeAIFileIngestResult';
+export * from './GenerativeAIFileIngestWorkerParameters';

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListCreateJobParameters.d.ts

@@ -0,0 +1,16 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+/**
+ * Represents the parameters to create a file list job
+ * @category AI
+ */
+export interface IGenerativeAIFileListCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileList;
+    /**
+     * The collection id of the file to list.
+     */
+    collectionId: string;
+}

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListCreateJobParameters.js

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

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListJob.d.ts

@@ -0,0 +1,17 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIFileListResult } from './GenerativeAIFileListResult';
+/**
+ * Represents bounded file list job ready to be executed
+ * @category AI
+ */
+export interface IGenerativeAIFileListJob extends IGenerativeAIJob {
+    /**
+     * The collection id of the file to list.
+     */
+    collectionId: string;
+    /**
+     * Run the file list job.
+     * @returns A promise that resolves with the result.
+     */
+    run: () => Promise<IGenerativeAIFileListResult>;
+}

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListJob.js

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

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListResult.d.ts

@@ -0,0 +1,36 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
+/**
+ * The AI file Interface
+ * Represents a file in the AI file list.
+ * @category AI
+ */
+export interface IGenerativeAIFile {
+    /**
+     * The file name.
+     */
+    name: string;
+    /**
+     * The file id.
+     */
+    id: string;
+    /**
+     * The file status.
+     */
+    status: string;
+}
+/**
+ * The AI file list result Interface
+ * Represents the result of an AI file list.
+ * @category AI
+ */
+export interface IGenerativeAIFileListResult extends IGenerativeAIJobResult {
+    /**
+     * The file list AI job type.
+     */
+    type: GenerativeAIJobType.FileList;
+    /**
+     * The list of files.
+     */
+    files: IGenerativeAIFile[];
+}

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListResult.js

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

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListWorkerParameters.d.ts

@@ -0,0 +1,16 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * Parameters for the File List worker.
+ * @category AI
+ */
+export interface IGenerativeAIFileListWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.FileList;
+    /**
+     * The collection id to list files from.
+     */
+    collectionId: string;
+}

package/dist/generative-ai/jobs/file-list/GenerativeAIFileListWorkerParameters.js

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

package/dist/generative-ai/jobs/file-list/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileListCreateJobParameters';
+export * from './GenerativeAIFileListJob';
+export * from './GenerativeAIFileListResult';
+export * from './GenerativeAIFileListWorkerParameters';

package/dist/generative-ai/jobs/file-list/index.js

@@ -0,0 +1,4 @@
+export * from './GenerativeAIFileListCreateJobParameters';
+export * from './GenerativeAIFileListJob';
+export * from './GenerativeAIFileListResult';
+export * from './GenerativeAIFileListWorkerParameters';

package/dist/generative-ai/jobs/generic/GenerativeAICreateJobParameters.d.ts

@@ -4,6 +4,10 @@ import { IGenerativeAIOptions } from './GenerativeAIOptions';
  * @category AI
  */
 export interface IGenerativeAICreateJobParameters {
+    /**
+     * The vendor id of the job.
+     */
+    vendorId: string;
     /**
      * The options for the job.
      */

package/dist/generative-ai/jobs/generic/GenerativeAIJob.d.ts

@@ -7,4 +7,8 @@ export interface IGenerativeAIJob {
      * The job ID.
      */
     id: string;
+    /**
+     * The vendor id of the job.
+     */
+    vendorId: string;
 }

package/dist/generative-ai/jobs/generic/GenerativeAIWorkerParameters.d.ts

@@ -1,12 +1,20 @@
 import { GenerativeAIJobType } from '../../GenerativeAIJobType';
-import { IJobParametersGenerativeAI } from '../../job/JobParametersGenerativeAI';
+import { IGenerativeAIJobParameters } from '../../job/GenerativeAIJobParameters';
 /**
  * Base AI job parameters Interface
  * @category AI
  */
-export interface IGenerativeAIWorkerParameters extends IJobParametersGenerativeAI {
+export interface IGenerativeAIWorkerParameters extends IGenerativeAIJobParameters {
     /**
      * The AI job type.
      */
     type: GenerativeAIJobType;
+    /**
+     * The vendor ID.
+     */
+    vendorId: string;
+    /**
+     * The workflow ID.
+     */
+    workflowId?: string;
 }

package/dist/generative-ai/jobs/index.d.ts

@@ -1,5 +1,14 @@
-export * from './download-document';
+export * from './collection-create';
+export * from './collection-delete';
+export * from './collection-query';
+export * from './embed';
+export * from './file-delete';
+export * from './file-download';
+export * from './file-ingest';
+export * from './file-list';
 export * from './generic';
+export * from './inference';
 export * from './prompt';
 export * from './rating';
-export * from './search';
+export * from './realtime-session-create';
+export * from './tool-call';

package/dist/generative-ai/jobs/index.js

@@ -1,5 +1,14 @@
-export * from './download-document';
+export * from './collection-create';
+export * from './collection-delete';
+export * from './collection-query';
+export * from './embed';
+export * from './file-delete';
+export * from './file-download';
+export * from './file-ingest';
+export * from './file-list';
 export * from './generic';
+export * from './inference';
 export * from './prompt';
 export * from './rating';
-export * from './search';
+export * from './realtime-session-create';
+export * from './tool-call';

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

@@ -0,0 +1,60 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+import { IPromptHistory } from '../prompt';
+import { IGenerativeAIInferenceTool } from './GenerativeAIInferenceWorkerParameters';
+/**
+ * Represents the parameters to create an inference job
+ * @category AI
+ */
+export interface IGenerativeAIInferenceCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Inference;
+    /**
+     * The thread id
+     */
+    threadId: string;
+    /**
+     * The prompt to be processed.
+     */
+    prompt: string;
+    /**
+     * The instructions for the AI job.
+     */
+    instructions?: string;
+    /**
+     * The grammar to use for the AI job.
+     */
+    grammar?: any;
+    /**
+     * Enable reasoning for the AI job.
+     */
+    reasoning?: boolean;
+    /**
+     * The context for the AI job.
+     */
+    history?: IPromptHistory[];
+    /**
+     * The model to use for inference.
+     */
+    model: string;
+    /**
+     * The temperature for the inference.
+     */
+    temperature?: number;
+    /**
+     * The max tokens for the inference.
+     */
+    maxTokens?: number;
+    /**
+     * tools for the AI job.
+     */
+    tools?: IGenerativeAIInferenceTool[];
+    /**
+     * The internal context used by the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
+}

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

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