@crewdle/web-sdk-types 1.0.23 → 1.0.25

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

@@ -0,0 +1,21 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+import { IGenerativeAIPromptOptions } from './GenerativeAIPromptOptions';
+/**
+ * Represents the parameters of a prompt job.
+ * @category AI
+ */
+export interface IGenerativeAIPromptCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The prompt job type.
+     */
+    type: GenerativeAIJobType.Prompt;
+    /**
+     * The prompt to be processed.
+     */
+    prompt: string;
+    /**
+     * The options for the prompt.
+     */
+    options?: IGenerativeAIPromptOptions;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptCreateJobParameters.js

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

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

@@ -0,0 +1,26 @@
+import { IGenerativeAIPromptOptions, IGenerativeAIPromptResult } from '.';
+import { IGenerativeAIJob } from '../generic';
+/**
+ * Represents bounded prompt job ready to be run or streamed.
+ * @category AI
+ */
+export interface IGenerativeAIPromptJob extends IGenerativeAIJob {
+    /**
+     * The prompt to be processed
+     */
+    prompt: string;
+    /**
+     * The options for the prompt.
+     */
+    options: IGenerativeAIPromptOptions;
+    /**
+     * Run the prompt job.
+     * @returns A promise that resolves with the result
+     */
+    run: () => Promise<IGenerativeAIPromptResult>;
+    /**
+     * Stream the prompt job.
+     * @returns An async generator that yields the result
+     */
+    stream: () => AsyncGenerator<IGenerativeAIPromptResult>;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptJob.js

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

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

@@ -0,0 +1,43 @@
+import { IGenerativeAIOptions } from '../generic/GenerativeAIOptions';
+import { IPromptFunction, IPromptHistory } from './options';
+/**
+ * The AI prompt options Interface
+ * Represents the options for an AI prompt.
+ * @category AI
+ */
+export interface IGenerativeAIPromptOptions extends IGenerativeAIOptions {
+    /**
+     * The thread id
+     */
+    threadId: string;
+    /**
+     * The instructions for the AI job.
+     */
+    instructions?: string;
+    /**
+     * The grammar to use for the AI job.
+     */
+    grammar?: string;
+    /**
+     * The context for the AI job.
+     */
+    history?: IPromptHistory[];
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
+    /**
+     * The maximum number of tokens to generate.
+     */
+    maxTokens?: number;
+    /**
+     * The temperature for the LLM.
+     */
+    temperature?: number;
+    /**
+     * The functions that can be called by the LLM.
+     */
+    functions?: Map<string, IPromptFunction>;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptOptions.js

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

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

@@ -0,0 +1,37 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IJobResultGenerativeAI } from '../../job/JobResultGenerativeAI';
+import { ISearchResult } from '../../search';
+import { PromptTypeText, PromptTypeVector } from './result';
+/**
+ * The AI prompt result Interface
+ * Represents the result of an AI prompt.
+ * @category AI
+ */
+export interface IGenerativeAIPromptResult extends IJobResultGenerativeAI {
+    /**
+     * The prompt AI job type.
+     */
+    type: GenerativeAIJobType.Prompt;
+    /**
+     * The output of the AI job.
+     */
+    output?: PromptTypeText | PromptTypeVector;
+    /**
+     * The relevant context used by the AI job.
+     */
+    context?: ISearchResult[];
+    /**
+     * The internal context used by the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
+    /**
+     * The tokens used by the AI job.
+     */
+    inputTokens?: number;
+    /**
+     * The tokens generated by the AI job.
+     */
+    outputTokens?: number;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptResult.js

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

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

@@ -0,0 +1,17 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerConnectorParameters } from '../generic/GenerativeAIWorkerConnectorParameters';
+import { IGenerativeAIPromptOptions } from './GenerativeAIPromptOptions';
+/**
+ * AI prompt worker connector parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAIPromptWorkerConnectorParameters extends IGenerativeAIWorkerConnectorParameters, IGenerativeAIPromptOptions {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Prompt;
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptWorkerConnectorParameters.js

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

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

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic/GenerativeAIWorkerParameters';
+/**
+ * AI prompt job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAIPromptWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Prompt;
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+    /**
+     * The thread ID
+     */
+    threadId: string;
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptWorkerParameters.js

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

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

@@ -0,0 +1,7 @@
+import { IGenerativeAIPromptResult } from './GenerativeAIPromptResult';
+/**
+ * AI worker connector prompt result Interface
+ * @category AI
+ */
+export interface IGenerativeAIWorkerConnectorPromptResult extends IGenerativeAIPromptResult {
+}

package/dist/generative-ai/jobs/prompt/GenerativeAIWorkerConnectorPromptResult.js

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

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

@@ -0,0 +1,9 @@
+export * from './options';
+export * from './result';
+export * from './GenerativeAIPromptCreateJobParameters';
+export * from './GenerativeAIPromptJob';
+export * from './GenerativeAIPromptOptions';
+export * from './GenerativeAIPromptResult';
+export * from './GenerativeAIPromptWorkerConnectorParameters';
+export * from './GenerativeAIPromptWorkerParameters';
+export * from './GenerativeAIWorkerConnectorPromptResult';

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

@@ -0,0 +1,9 @@
+export * from './options';
+export * from './result';
+export * from './GenerativeAIPromptCreateJobParameters';
+export * from './GenerativeAIPromptJob';
+export * from './GenerativeAIPromptOptions';
+export * from './GenerativeAIPromptResult';
+export * from './GenerativeAIPromptWorkerConnectorParameters';
+export * from './GenerativeAIPromptWorkerParameters';
+export * from './GenerativeAIWorkerConnectorPromptResult';

package/dist/generative-ai/jobs/prompt/options/PromptFunction.d.ts

@@ -0,0 +1,22 @@
+import { IPromptFunctionParams } from './PromptFunctionParams';
+/**
+ * The AI prompt function Interface
+ * Represents a function that can be called by the LLM.
+ * @category AI
+ */
+export interface IPromptFunction {
+    /**
+     * The function description.
+     */
+    description: string;
+    /**
+     * The function parameters.
+     */
+    params?: IPromptFunctionParams;
+    /**
+     * The function callback.
+     */
+    callback: (params?: {
+        [key: string]: string | number | boolean;
+    }) => string | Promise<string>;
+}

package/dist/generative-ai/jobs/prompt/options/PromptFunction.js

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

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParams.d.ts

@@ -0,0 +1,11 @@
+import { PromptFunctionParamsType } from './PromptFunctionParamsType';
+/**
+ * The AI prompt function parameters Interface
+ * Represents the parameters for a prompt function.
+ * @category AI
+ */
+export interface IPromptFunctionParams {
+    [key: string]: {
+        type: PromptFunctionParamsType;
+    };
+}

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParams.js

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

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParamsType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The type of parameters supported for agentic functions
+ */
+export declare enum PromptFunctionParamsType {
+    /**
+     * The parameter is a string.
+     */
+    String = "string",
+    /**
+     * The parameter is a number.
+     */
+    Number = "number",
+    /**
+     * The parameter is a boolean.
+     */
+    Boolean = "boolean"
+}

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParamsType.js

@@ -0,0 +1,18 @@
+/**
+ * The type of parameters supported for agentic functions
+ */
+export var PromptFunctionParamsType;
+(function (PromptFunctionParamsType) {
+    /**
+     * The parameter is a string.
+     */
+    PromptFunctionParamsType["String"] = "string";
+    /**
+     * The parameter is a number.
+     */
+    PromptFunctionParamsType["Number"] = "number";
+    /**
+     * The parameter is a boolean.
+     */
+    PromptFunctionParamsType["Boolean"] = "boolean";
+})(PromptFunctionParamsType || (PromptFunctionParamsType = {}));

package/dist/generative-ai/jobs/prompt/options/PromptHistory.d.ts

@@ -0,0 +1,16 @@
+import { PromptSource } from './PromptSource';
+/**
+ * The AI prompt history Interface
+ * Represents the history of a prompt.
+ * @category AI
+ */
+export interface IPromptHistory {
+    /**
+     * The source of the prompt.
+     */
+    source: PromptSource;
+    /**
+     * The prompt.
+     */
+    message: string;
+}

package/dist/generative-ai/jobs/prompt/options/PromptHistory.js

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

package/dist/generative-ai/jobs/prompt/options/PromptSource.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The AI prompt source Enum
+ * @category AI
+ */
+export declare enum PromptSource {
+    /**
+     * The prompt was generated by the AI.
+     */
+    AI = "ai",
+    /**
+     * The prompt was generated by a human.
+     */
+    Human = "human"
+}

package/dist/generative-ai/jobs/prompt/options/PromptSource.js

@@ -0,0 +1,16 @@
+/**
+ * The AI prompt source Enum
+ * @category AI
+ */
+export var PromptSource;
+(function (PromptSource) {
+    /**
+     * The prompt was generated by the AI.
+     */
+    PromptSource["AI"] = "ai";
+    /**
+     * The prompt was generated by a human.
+     */
+    PromptSource["Human"] = "human";
+})(PromptSource || (PromptSource = {}));
+;

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

@@ -0,0 +1,5 @@
+export * from './PromptFunction';
+export * from './PromptFunctionParams';
+export * from './PromptFunctionParamsType';
+export * from './PromptHistory';
+export * from './PromptSource';

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

@@ -0,0 +1,5 @@
+export * from './PromptFunction';
+export * from './PromptFunctionParams';
+export * from './PromptFunctionParamsType';
+export * from './PromptHistory';
+export * from './PromptSource';

package/dist/generative-ai/jobs/prompt/result/PromptTypeText.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The AI prompt type text
+ */
+export type PromptTypeText = string | string[];

package/dist/generative-ai/jobs/prompt/result/PromptTypeText.js

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

package/dist/generative-ai/jobs/prompt/result/PromptTypeVector.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The AI prompt type vector
+ */
+export type PromptTypeVector = number[];

package/dist/generative-ai/jobs/prompt/result/PromptTypeVector.js

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

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

@@ -0,0 +1,2 @@
+export * from './PromptTypeText';
+export * from './PromptTypeVector';

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

@@ -0,0 +1,2 @@
+export * from './PromptTypeText';
+export * from './PromptTypeVector';

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

@@ -0,0 +1,8 @@
+/**
+ * The AI prompt rating Enum
+ * @category AI
+ */
+export declare enum GenerativeAIRating {
+    Up = "up",
+    Down = "down"
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRating.js

@@ -0,0 +1,9 @@
+/**
+ * The AI prompt rating Enum
+ * @category AI
+ */
+export var GenerativeAIRating;
+(function (GenerativeAIRating) {
+    GenerativeAIRating["Up"] = "up";
+    GenerativeAIRating["Down"] = "down";
+})(GenerativeAIRating || (GenerativeAIRating = {}));

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

@@ -0,0 +1,26 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic';
+import { GenerativeAIRating } from './GenerativeAIRating';
+import { IGenerativeAIRatingOptions } from './GenerativeAIRatingOptions';
+/**
+ * Represents the parameters of a rating job.
+ * @category AI
+ */
+export interface IGenerativeAIRatingCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The rating job type.
+     */
+    type: GenerativeAIJobType.Rating;
+    /**
+     * The job ID associated with the message.
+     */
+    jobId: string;
+    /**
+     * The rating of the prompt.
+     */
+    rating: GenerativeAIRating;
+    /**
+     * The options for the rating.
+     */
+    options: IGenerativeAIRatingOptions;
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRatingCreateJobParameters.js

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

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

@@ -0,0 +1,25 @@
+import { IGenerativeAIRatingOptions, IGenerativeAIRatingResult, GenerativeAIRating } from '.';
+import { IGenerativeAIJob } from '../generic';
+/**
+ * Represents bounded rating job ready to be run or streamed.
+ * @category AI
+ */
+export interface IGenerativeAIRatingJob extends IGenerativeAIJob {
+    /**
+     * The job ID.
+     */
+    id: string;
+    /**
+     * The rating for the job.
+     */
+    rating: GenerativeAIRating;
+    /**
+     * The options for the rating.
+     */
+    options: IGenerativeAIRatingOptions;
+    /**
+     * Run the rating job.
+     * @returns A promise that resolves with the result
+     */
+    rate: () => Promise<IGenerativeAIRatingResult>;
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRatingJob.js

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

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

@@ -0,0 +1,16 @@
+import { IGenerativeAIOptions } from '../generic/GenerativeAIOptions';
+/**
+ * The AI rating options Interface
+ * Represents the options for an AI rating.
+ * @category AI
+ */
+export interface IGenerativeAIRatingOptions extends IGenerativeAIOptions {
+    /**
+     * The thread id
+     */
+    threadId: string;
+    /**
+     * The user feedback for the AI job.
+     */
+    feedback?: string;
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRatingOptions.js

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

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

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

package/dist/generative-ai/jobs/rating/GenerativeAIRatingResult.js

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

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

@@ -0,0 +1,8 @@
+/**
+ * The AI rating status Enum
+ * @category AI
+ */
+export declare enum GenerativeAIRatingStatus {
+    Success = "success",
+    Error = "error"
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRatingStatus.js

@@ -0,0 +1,9 @@
+/**
+ * The AI rating status Enum
+ * @category AI
+ */
+export var GenerativeAIRatingStatus;
+(function (GenerativeAIRatingStatus) {
+    GenerativeAIRatingStatus["Success"] = "success";
+    GenerativeAIRatingStatus["Error"] = "error";
+})(GenerativeAIRatingStatus || (GenerativeAIRatingStatus = {}));

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

@@ -0,0 +1,29 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { GenerativeAIRating } from './GenerativeAIRating';
+import { IGenerativeAIWorkerParameters } from '../generic/GenerativeAIWorkerParameters';
+/**
+ * AI rating job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAIRatingWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Rating;
+    /**
+     * The job ID.
+     */
+    jobId: string;
+    /**
+     * The rating for the AI prompt.
+     */
+    rating: GenerativeAIRating;
+    /**
+     * The thread ID
+     */
+    threadId: string;
+    /**
+     * The feedback for the AI prompt
+     */
+    feedback?: string;
+}

package/dist/generative-ai/jobs/rating/GenerativeAIRatingWorkerParameters.js

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

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

@@ -0,0 +1,7 @@
+export * from './GenerativeAIRatingCreateJobParameters';
+export * from './GenerativeAIRatingJob';
+export * from './GenerativeAIRatingStatus';
+export * from './GenerativeAIRating';
+export * from './GenerativeAIRatingOptions';
+export * from './GenerativeAIRatingWorkerParameters';
+export * from './GenerativeAIRatingResult';

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

@@ -0,0 +1,7 @@
+export * from './GenerativeAIRatingCreateJobParameters';
+export * from './GenerativeAIRatingJob';
+export * from './GenerativeAIRatingStatus';
+export * from './GenerativeAIRating';
+export * from './GenerativeAIRatingOptions';
+export * from './GenerativeAIRatingWorkerParameters';
+export * from './GenerativeAIRatingResult';

package/dist/generative-ai/search/SearchConnector.js

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

package/dist/generative-ai/search/SearchConnectorConstructor.js

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

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

@@ -0,0 +1,19 @@
+/**
+ * Represents a search result.
+ * @category AI
+ */
+export interface ISearchResult {
+    /**
+     * The content of the search result.
+     */
+    content: string;
+    /**
+     * The relevance of the search result.
+     * The relevance is a number between 0 and 1, where 1 is the most relevant.
+     */
+    relevance: number;
+    /**
+     * The path name of the document containing the search result.
+     */
+    pathName: string;
+}

package/dist/generative-ai/search/SearchResult.js

@@ -0,0 +1,5 @@
+/**
+ * Represents a search result.
+ * @category AI
+ */
+export {};

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

@@ -0,0 +1,3 @@
+export * from './SearchConnector';
+export * from './SearchConnectorConstructor';
+export * from './SearchResult';

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

@@ -0,0 +1,3 @@
+export * from './SearchConnector';
+export * from './SearchConnectorConstructor';
+export * from './SearchResult';