@crewdle/web-sdk-types 1.0.32 → 1.0.34

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

@@ -0,0 +1,65 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIPromptResult, IPromptHistory } from '../prompt';
+import { IGenerativeAIInferenceTool } from './GenerativeAIInferenceWorkerParameters';
+/**
+ * Represents bounded inference job ready to be executed
+ * @category AI
+ */
+export interface IGenerativeAIInferenceJob extends IGenerativeAIJob {
+    /**
+     * 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;
+    };
+    /**
+     * Run the inference job.
+     * @returns A promise that resolves with the result.
+     */
+    run: () => Promise<IGenerativeAIPromptResult>;
+    /**
+     * Stream the inference job.
+     * @returns A promise that resolves with the result.
+     */
+    stream: () => AsyncGenerator<IGenerativeAIPromptResult>;
+}

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

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

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

@@ -0,0 +1,162 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+import { IPromptHistory } from '../prompt';
+/**
+ * Parameters for the Inference worker.
+ * @category AI
+ */
+export interface IGenerativeAIInferenceWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * 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;
+    };
+}
+/**
+ * The interface for the generative AI inference tool.
+ * @category AI
+ */
+export interface IGenerativeAIInferenceTool {
+    /**
+     * The type of the tool.
+     */
+    type: GenerativeAIInferenceToolType;
+    /**
+     * The name of the tool.
+     */
+    name: string;
+    /**
+     * The description of the tool.
+     */
+    description?: string;
+    /**
+     * The parameters for the tool.
+     */
+    parameters?: IGenerativeAIInferenceToolParameter[];
+    /**
+     * The endpoint URL for the tool.
+     */
+    endpointUrl?: string;
+    /**
+     * The endpoint method for the tool.
+     */
+    endpointMethod?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    /**
+     * The headers for the tool.
+     */
+    headers?: {
+        name: string;
+        value: string;
+    }[];
+    /**
+     * The query parameters for the tool.
+     */
+    queryParameters?: {
+        name: string;
+        value: string;
+    }[];
+    /**
+     * The body parameters for the tool.
+     */
+    bodyParameters?: {
+        name: string;
+        value: string;
+    }[];
+    /**
+     * The model ID to use for the tool.
+     */
+    modelId?: string;
+    /**
+     * The instructions for the tool.
+     */
+    instructions?: string;
+    /**
+     * The max tokens for the tool.
+     */
+    maxTokens?: number;
+    /**
+     * The temperature for the tool.
+     */
+    temperature?: number;
+    /**
+     * The collection ID for the tool.
+     */
+    collectionId?: string;
+}
+/**
+ * The enum for the generative AI inference tool type.
+ * @category AI
+ */
+export declare enum GenerativeAIInferenceToolType {
+    Agent = "agent",
+    AgentSkill = "agent-skill",
+    CustomSkill = "custom-skill",
+    DataCollection = "data-collection",
+    Knowledge = "knowledge",
+    AISearch = "ai-search",
+    Code = "code",
+    QueryFile = "query-file",
+    Search = "search",
+    WebScraper = "web-scraper",
+    WebScraperRaw = "web-scraper-raw",
+    WriteFile = "write-file"
+}
+/**
+ * The interface for the generative AI inference tool parameter.
+ * @category AI
+ */
+export interface IGenerativeAIInferenceToolParameter {
+    /**
+     * The name of the parameter.
+     */
+    name: string;
+    /**
+     * The type of the parameter.
+     */
+    type: 'string' | 'number' | 'boolean' | 'json';
+}

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

@@ -0,0 +1,19 @@
+/**
+ * The enum for the generative AI inference tool type.
+ * @category AI
+ */
+export var GenerativeAIInferenceToolType;
+(function (GenerativeAIInferenceToolType) {
+    GenerativeAIInferenceToolType["Agent"] = "agent";
+    GenerativeAIInferenceToolType["AgentSkill"] = "agent-skill";
+    GenerativeAIInferenceToolType["CustomSkill"] = "custom-skill";
+    GenerativeAIInferenceToolType["DataCollection"] = "data-collection";
+    GenerativeAIInferenceToolType["Knowledge"] = "knowledge";
+    GenerativeAIInferenceToolType["AISearch"] = "ai-search";
+    GenerativeAIInferenceToolType["Code"] = "code";
+    GenerativeAIInferenceToolType["QueryFile"] = "query-file";
+    GenerativeAIInferenceToolType["Search"] = "search";
+    GenerativeAIInferenceToolType["WebScraper"] = "web-scraper";
+    GenerativeAIInferenceToolType["WebScraperRaw"] = "web-scraper-raw";
+    GenerativeAIInferenceToolType["WriteFile"] = "write-file";
+})(GenerativeAIInferenceToolType || (GenerativeAIInferenceToolType = {}));

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

@@ -0,0 +1,3 @@
+export * from './GenerativeAIInferenceCreateJobParameters';
+export * from './GenerativeAIInferenceJob';
+export * from './GenerativeAIInferenceWorkerParameters';

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

@@ -0,0 +1,3 @@
+export * from './GenerativeAIInferenceCreateJobParameters';
+export * from './GenerativeAIInferenceJob';
+export * from './GenerativeAIInferenceWorkerParameters';

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptCreateJobParameters.d.ts

@@ -1,6 +1,6 @@
 import { GenerativeAIJobType } from '../../GenerativeAIJobType';
 import { IGenerativeAICreateJobParameters } from '../generic';
-import { IGenerativeAIPromptOptions } from './GenerativeAIPromptOptions';
+import { IPromptHistory } from './options';
 /**
  * Represents the parameters of a prompt job.
  * @category AI
@@ -10,12 +10,26 @@ export interface IGenerativeAIPromptCreateJobParameters extends IGenerativeAICre
      * The prompt job type.
      */
     type: GenerativeAIJobType.Prompt;
+    /**
+     * The workflow id to use for the prompt.
+     */
+    workflowId: string;
     /**
      * The prompt to be processed.
      */
     prompt: string;
     /**
-     * The options for the prompt.
+     * The thread id
+     */
+    threadId: string;
+    /**
+     * The context for the AI job.
+     */
+    history?: IPromptHistory[];
+    /**
+     * The internal context for the AI job.
      */
-    options?: IGenerativeAIPromptOptions;
+    internalContext?: {
+        [key: string]: string;
+    };
 }

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptJob.d.ts

@@ -1,18 +1,32 @@
-import { IGenerativeAIPromptOptions, IGenerativeAIPromptResult } from '.';
+import { IGenerativeAIPromptResult, IPromptHistory } from '.';
 import { IGenerativeAIJob } from '../generic';
 /**
  * Represents bounded prompt job ready to be run or streamed.
  * @category AI
  */
 export interface IGenerativeAIPromptJob extends IGenerativeAIJob {
+    /**
+     * The workflow id to use for the prompt.
+     */
+    workflowId: string;
     /**
      * The prompt to be processed
      */
     prompt: string;
     /**
-     * The options for the prompt.
+     * The thread id
+     */
+    threadId: string;
+    /**
+     * The context for the AI job.
+     */
+    history?: IPromptHistory[];
+    /**
+     * The internal context for the AI job.
      */
-    options: IGenerativeAIPromptOptions;
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * Run the prompt job.
      * @returns A promise that resolves with the result

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptOptions.d.ts

@@ -32,6 +32,10 @@ export interface IGenerativeAIPromptOptions extends IGenerativeAIOptions {
      * The grammar to use for the AI job.
      */
     grammar?: string;
+    /**
+     * Enable reasoning for the AI job.
+     */
+    reasoning?: boolean;
     /**
      * The context for the AI job.
      */

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptResult.d.ts

@@ -1,5 +1,5 @@
 import { GenerativeAIJobType } from '../../GenerativeAIJobType';
-import { IJobResultGenerativeAI } from '../../job/JobResultGenerativeAI';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
 import { ISearchResult } from '../../search';
 import { PromptTypeText, PromptTypeVector } from './result';
 /**
@@ -7,11 +7,11 @@ import { PromptTypeText, PromptTypeVector } from './result';
  * Represents the result of an AI prompt.
  * @category AI
  */
-export interface IGenerativeAIPromptResult extends IJobResultGenerativeAI {
+export interface IGenerativeAIPromptResult extends IGenerativeAIJobResult {
     /**
      * The prompt AI job type.
      */
-    type: GenerativeAIJobType.Prompt;
+    type: GenerativeAIJobType.Prompt | GenerativeAIJobType.Inference | GenerativeAIJobType.Embed;
     /**
      * The output of the AI job.
      */

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptWorkerParameters.d.ts

@@ -9,6 +9,10 @@ export interface IGenerativeAIPromptWorkerParameters extends IGenerativeAIWorker
      * The AI job type.
      */
     type: GenerativeAIJobType.Prompt;
+    /**
+     * The workflow ID.
+     */
+    workflowId: string;
     /**
      * The prompt for the AI job.
      */

package/dist/generative-ai/jobs/rating/GenerativeAIRatingCreateJobParameters.d.ts

@@ -11,6 +11,10 @@ export interface IGenerativeAIRatingCreateJobParameters extends IGenerativeAICre
      * The rating job type.
      */
     type: GenerativeAIJobType.Rating;
+    /**
+     * The workflow ID associated with the message.
+     */
+    workflowId: string;
     /**
      * The job ID associated with the message.
      */

package/dist/generative-ai/jobs/rating/GenerativeAIRatingJob.d.ts

@@ -5,10 +5,6 @@ import { IGenerativeAIJob } from '../generic';
  * @category AI
  */
 export interface IGenerativeAIRatingJob extends IGenerativeAIJob {
-    /**
-     * The job ID.
-     */
-    id: string;
     /**
      * The rating for the job.
      */
@@ -21,5 +17,5 @@ export interface IGenerativeAIRatingJob extends IGenerativeAIJob {
      * Run the rating job.
      * @returns A promise that resolves with the result
      */
-    rate: () => Promise<IGenerativeAIRatingResult>;
+    run: () => Promise<IGenerativeAIRatingResult>;
 }

package/dist/generative-ai/jobs/rating/GenerativeAIRatingResult.d.ts

@@ -1,12 +1,12 @@
 import { GenerativeAIJobType } from '../../GenerativeAIJobType';
-import { IJobResultGenerativeAI } from '../../job/JobResultGenerativeAI';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
 import { GenerativeAIRatingStatus } from './GenerativeAIRatingStatus';
 /**
  * The AI rating result Interface
  * Represents the result of an AI rating.
  * @category AI
  */
-export interface IGenerativeAIRatingResult extends IJobResultGenerativeAI {
+export interface IGenerativeAIRatingResult extends IGenerativeAIJobResult {
     /**
      * The rating AI job type.
      */

package/dist/generative-ai/jobs/rating/GenerativeAIRatingWorkerParameters.d.ts

@@ -10,6 +10,10 @@ export interface IGenerativeAIRatingWorkerParameters extends IGenerativeAIWorker
      * The AI job type.
      */
     type: GenerativeAIJobType.Rating;
+    /**
+     * The workflow ID.
+     */
+    workflowId: string;
     /**
      * The job ID.
      */

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateCreateJobParameters.d.ts

@@ -0,0 +1,16 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+/**
+ * Represents the parameters to create a realtime session create job
+ * @category AI
+ */
+export interface IGenerativeAIRealtimeSessionCreateCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.RealtimeSessionCreate;
+    /**
+     * The workflow ID associated with the message.
+     */
+    workflowId: string;
+}

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateCreateJobParameters.js

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

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateJob.d.ts

@@ -0,0 +1,17 @@
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIRealtimeSessionCreateResult } from './GenerativeAIRealtimeSessionCreateResult';
+/**
+ * Represents the parameters to create a realtime session create job
+ * @category AI
+ */
+export interface IGenerativeAIRealtimeSessionCreateJob extends IGenerativeAIJob {
+    /**
+     * The workflow ID.
+     */
+    workflowId: string;
+    /**
+     * Runs the job.
+     * @returns A promise that resolves with the result of the job.
+     */
+    run: () => Promise<IGenerativeAIRealtimeSessionCreateResult>;
+}

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateJob.js

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

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateResult.d.ts

@@ -0,0 +1,41 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
+import { IGenerativeAIInferenceTool } from '../inference';
+/**
+ * The result of a RealtimeSessionCreate job.
+ * @category AI
+ */
+export interface IGenerativeAIRealtimeSessionCreateResult extends IGenerativeAIJobResult {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.RealtimeSessionCreate;
+    /**
+     * The API key.
+     */
+    apiKey: string;
+    /**
+     * The model ID.
+     */
+    modelId: string;
+    /**
+     * The instructions.
+     */
+    instructions: string;
+    /**
+     * The temperature.
+     */
+    temperature: number;
+    /**
+     * The max tokens.
+     */
+    maxTokens: number;
+    /**
+     * The initial prompt.
+     */
+    initialPrompt?: string;
+    /**
+     * The tools for the Realtime Session.
+     */
+    tools?: IGenerativeAIInferenceTool[];
+}

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateResult.js

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

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateWorkerParameters.d.ts

@@ -0,0 +1,16 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+/**
+ * AI realtime session create job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAIRealtimeSessionCreateWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.RealtimeSessionCreate;
+    /**
+     * The workflow ID.
+     */
+    workflowId: string;
+}

package/dist/generative-ai/jobs/realtime-session-create/GenerativeAIRealtimeSessionCreateWorkerParameters.js

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

package/dist/generative-ai/jobs/realtime-session-create/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GenerativeAIRealtimeSessionCreateCreateJobParameters';
+export * from './GenerativeAIRealtimeSessionCreateJob';
+export * from './GenerativeAIRealtimeSessionCreateResult';
+export * from './GenerativeAIRealtimeSessionCreateWorkerParameters';

package/dist/generative-ai/jobs/realtime-session-create/index.js

@@ -0,0 +1,4 @@
+export * from './GenerativeAIRealtimeSessionCreateCreateJobParameters';
+export * from './GenerativeAIRealtimeSessionCreateJob';
+export * from './GenerativeAIRealtimeSessionCreateResult';
+export * from './GenerativeAIRealtimeSessionCreateWorkerParameters';

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

@@ -0,0 +1,23 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+import { IGenerativeAIInferenceTool } from '../inference';
+/**
+ * Represents the parameters to create a tool call job
+ * @category AI
+ */
+export interface IGenerativeAIToolCallCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.ToolCall;
+    /**
+     * The tool to be processed.
+     */
+    tool: IGenerativeAIInferenceTool;
+    /**
+     * The arguments for the tool.
+     */
+    arguments: {
+        [key: string]: string | number | boolean;
+    };
+}

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallCreateJobParameters.js

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

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

@@ -0,0 +1,23 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJob } from '../generic';
+import { IGenerativeAIInferenceTool } from '../inference';
+import { IGenerativeAIToolCallResult } from './GenerativeAIToolCallResult';
+/**
+ * Represents a tool call job.
+ * @category AI
+ */
+export interface IGenerativeAIToolCallJob extends IGenerativeAIJob {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.ToolCall;
+    /**
+     * The tool to be processed.
+     */
+    tool: IGenerativeAIInferenceTool;
+    /**
+     * Runs the job.
+     * @returns A promise that resolves with the result of the job.
+     */
+    run: () => Promise<IGenerativeAIToolCallResult>;
+}

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallJob.js

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

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

@@ -0,0 +1,16 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIJobResult } from '../../job/GenerativeAIJobResult';
+/**
+ * The result of a ToolCall job.
+ * @category AI
+ */
+export interface IGenerativeAIToolCallResult extends IGenerativeAIJobResult {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.ToolCall;
+    /**
+     * The output of the tool.
+     */
+    output: string;
+}

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallResult.js

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

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

@@ -0,0 +1,23 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic';
+import { IGenerativeAIInferenceTool } from '../inference';
+/**
+ * Represents the parameters to call a tool.
+ * @category AI
+ */
+export interface IGenerativeAIToolCallWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.ToolCall;
+    /**
+     * The tool to be processed.
+     */
+    tool: IGenerativeAIInferenceTool;
+    /**
+     * The arguments for the tool.
+     */
+    arguments: {
+        [key: string]: string | number | boolean;
+    };
+}

package/dist/generative-ai/jobs/tool-call/GenerativeAIToolCallWorkerParameters.js

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

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

@@ -0,0 +1,4 @@
+export * from './GenerativeAIToolCallCreateJobParameters';
+export * from './GenerativeAIToolCallJob';
+export * from './GenerativeAIToolCallResult';
+export * from './GenerativeAIToolCallWorkerParameters';