@llumiverse/common 0.20.0 → 0.22.0-dev.1

package/src/options.ts

@@ -3,18 +3,24 @@ import { getGroqOptions } from "./options/groq.js";
 import { getOpenAiOptions } from "./options/openai.js";
 import { getVertexAiOptions } from "./options/vertexai.js";
 import { textOptionsFallback } from "./options/fallback.js";
-import { ModelOptionsInfo, ModelOptions } from "./types.js";
+import { ModelOptionsInfo, ModelOptions, Providers } from "./types.js";
+import { getAzureFoundryOptions } from "./options/azure_foundry.js";
 
-export function getOptions(model: string, provider?: string, options?: ModelOptions): ModelOptionsInfo {
-    switch (provider?.toLowerCase()) {
-        case "bedrock":
-            return getBedrockOptions(model ?? "", options);
-        case "vertexai":
-            return getVertexAiOptions(model ?? "", options);
-        case "openai":
-            return getOpenAiOptions(model ?? "", options);
-        case "groq":
-            return getGroqOptions(model ?? "", options);
+export function getOptions(model: string, provider?: string | Providers, options?: ModelOptions): ModelOptionsInfo {
+    if(!provider) {
+        return textOptionsFallback;
+    }
+    switch (provider.toLowerCase()) {
+        case Providers.bedrock:
+            return getBedrockOptions(model, options);
+        case Providers.vertexai:
+            return getVertexAiOptions(model, options);
+        case Providers.openai:
+            return getOpenAiOptions(model, options);
+        case Providers.groq:
+            return getGroqOptions(model, options);
+        case Providers.azure_foundry:
+            return getAzureFoundryOptions(model, options);
         default:
             return textOptionsFallback;
     }

package/src/types.ts

@@ -4,6 +4,119 @@ import { GroqOptions } from './options/groq.js';
 import { OpenAiOptions } from './options/openai.js';
 import { VertexAIOptions } from './options/vertexai.js';
 
+// ============== Provider details ===============
+
+export enum Providers {
+    openai = 'openai',
+    azure_openai = 'azure_openai',
+    azure_foundry = 'azure_foundry',
+    huggingface_ie = 'huggingface_ie',
+    replicate = 'replicate',
+    bedrock = 'bedrock',
+    vertexai = 'vertexai',
+    togetherai = 'togetherai',
+    mistralai = 'mistralai',
+    groq = 'groq',
+    watsonx = 'watsonx'
+}
+
+export interface ProviderParams {
+    id: Providers;
+    name: string;
+    requiresApiKey: boolean;
+    requiresEndpointUrl: boolean;
+    endpointPlaceholder?: string;
+    supportSearch?: boolean;
+}
+
+export const ProviderList: Record<Providers, ProviderParams> = {
+    openai:
+    {
+        id: Providers.openai,
+        name: "OpenAI",
+        requiresApiKey: true,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    azure_openai:
+    {
+        id: Providers.azure_openai,
+        name: "Azure OpenAI",
+        requiresApiKey: false,
+        requiresEndpointUrl: true,
+        supportSearch: false,
+    },
+    azure_foundry:
+    {
+        id: Providers.azure_foundry,
+        name: "Azure Foundry",
+        requiresApiKey: true,
+        requiresEndpointUrl: true,
+        supportSearch: false,
+    },
+    huggingface_ie:
+    {
+        id: Providers.huggingface_ie,
+        name: "HuggingFace Inference Endpoint",
+        requiresApiKey: true,
+        requiresEndpointUrl: true,
+    },
+    replicate:
+    {
+        id: Providers.replicate,
+        name: "Replicate",
+        requiresApiKey: true,
+        requiresEndpointUrl: false,
+        supportSearch: true,
+    },
+    bedrock:
+    {
+        id: Providers.bedrock,
+        name: "AWS Bedrock",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        endpointPlaceholder: "region name (eg. us-east-1)",
+        supportSearch: false,
+    },
+    vertexai: {
+        id: Providers.vertexai,
+        name: "Google Vertex AI",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    togetherai: {
+        id: Providers.togetherai,
+        name: "Together AI",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    mistralai: {
+        id: Providers.mistralai,
+        name: "Mistral AI",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    groq: {
+        id: Providers.groq,
+        name: "Groq Cloud",
+        requiresApiKey: false,
+        requiresEndpointUrl: false,
+        supportSearch: false,
+    },
+    watsonx: {
+        id: Providers.watsonx,
+        name: "IBM WatsonX",
+        requiresApiKey: true,
+        requiresEndpointUrl: true,
+        supportSearch: false
+    },
+}
+
+// ============== Embeddings ===============
+
 export interface EmbeddingsOptions {
     /**
      * The text to generate the embeddings for. One of text or image is required.
@@ -39,20 +152,90 @@ export interface EmbeddingsResult {
 export interface ResultValidationError {
     code: 'validation_error' | 'json_error' | 'content_policy_violation';
     message: string;
-    data?: string;
+    data?: CompletionResult[];
+}
+
+// ============== Result Types ===============
+
+export interface BaseResult {
+    type: "text" | "json" | "image";
+    value: any;
+}
+
+export interface TextResult extends BaseResult {
+    type: "text";
+    value: string;
+}
+
+export interface JsonResult extends BaseResult {
+    type: "json";
+}
+
+export interface ImageResult extends BaseResult {
+    type: "image";
+    value: string; // base64 data url or real url
+}
+
+export type CompletionResult = TextResult | JsonResult | ImageResult;
+
+/**
+ * Output as string
+ */
+export function completionResultToString(result: CompletionResult): string {
+    switch (result.type) {
+        case "text":
+            return result.value;
+        case "json":
+            return JSON.stringify(result.value, null, 2);
+        case "image":
+            return result.value;
+    }
+}
+
+/**
+ * Output as JSON, only handles the first JSON result or tries to parse text as JSON
+ * Expects the text to be pure JSON if no JSON result is found
+ * Throws if no JSON result is found or if parsing fails
+ */
+export function parseCompletionResultsToJson(results: CompletionResult[]): any {
+    const jsonResults = results.filter(r => r.type === "json");
+    if (jsonResults.length >= 1) {
+        return jsonResults[0].value;
+        //TODO: Handle multiple json type results
+    }
+
+    const textResults = results.filter(r => r.type === "text").join();
+    if (textResults.length === 0) {
+        throw new Error("No JSON result found or failed to parse text");
+    }
+    try {
+        return JSON.parse(textResults);
+    }
+    catch {
+        throw new Error("No JSON result found or failed to parse text");
+    }
+}
+
+/**
+ * Output as JSON if possible, otherwise as concatenated text
+ * Joins text results with the specified separator, default is empty string
+ * If multiple JSON results are found only the first one is returned
+ */
+export function parseCompletionResults(result: CompletionResult[], separator: string = ""): any {
+    try {
+        return parseCompletionResultsToJson(result);
+    } catch {
+        return result.map(completionResultToString).join(separator);
+    }
 }
 
-//ResultT should be either JSONObject or string
 //Internal structure used in driver implementation.
-export interface CompletionChunkObject<ResultT = any> {
-    result: ResultT;
+export interface CompletionChunkObject {
+    result: CompletionResult[];
     token_usage?: ExecutionTokenUsage;
     finish_reason?: "stop" | "length" | string;
 }
 
-//Internal structure used in driver implementation.
-export type CompletionChunk = CompletionChunkObject | string;
-
 export interface ToolDefinition {
     name: string,
     description?: string,
@@ -72,10 +255,9 @@ export interface ToolUse<ParamsT = JSONObject> {
     tool_input: ParamsT | null
 }
 
-//ResultT should be either JSONObject or string
-export interface Completion<ResultT = any> {
+export interface Completion {
     // the driver impl must return the result and optionally the token_usage. the execution time is computed by the extended abstract driver
-    result: ResultT;
+    result: CompletionResult[];
     token_usage?: ExecutionTokenUsage;
     /**
      * Contains the tools from which the model awaits information.
@@ -103,12 +285,6 @@ export interface Completion<ResultT = any> {
     conversation?: unknown;
 }
 
-export interface ImageGeneration {
-
-    images?: string[];
-
-}
-
 export interface ExecutionResponse<PromptT = any> extends Completion {
     prompt: PromptT;
     /**
@@ -420,7 +596,7 @@ export interface TrainingOptions {
 
 export interface TrainingPromptOptions {
     segments: PromptSegment[];
-    completion: string | JSONObject;
+    completion: CompletionResult[]
     model: string; // the model to train
     schema?: JSONSchema; // the result schema f any
 }