Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python
13.5 KB
Raw Blame
import type { ProviderSettings } from "@/app/api/queries/useGetSettingsQuery";
import AiFoundryLogo from "@/components/icons/ai-foundry-logo";
import AnthropicLogo from "@/components/icons/anthropic-logo";
import AzureOpenAILogo from "@/components/icons/azure-openai-logo";
import GenericProviderLogo from "@/components/icons/generic-provider-logo";
import IBMLogo from "@/components/icons/ibm-logo";
import OllamaLogo from "@/components/icons/ollama-logo";
import OpenAILogo from "@/components/icons/openai-logo";
import OpenShiftAILogo from "@/components/icons/openshift-ai-logo";

/**
 * A provider key as the backend names it.
 *
 * Which providers exist — and which of them this deployment shows — comes from
 * `GET /api/models/providers`, driven by `config/model_providers.yaml` and
 * OPENRAG_RUN_MODE. So this is a plain string, not a closed union: a provider
 * added to that file must render without a frontend change. The keys below are
 * only the ones OpenRAG has bespoke chrome (logo, colours, forms) for.
 */
export type ModelProvider = string;

export const KNOWN_PROVIDERS = [
  "openai",
  "anthropic",
  "ollama",
  "watsonx",
  "watsonx_onprem",
  "rhoai",
  "azure_ai",
  "azure",
  "local",
] as const;

export type KnownModelProvider = (typeof KNOWN_PROVIDERS)[number];

/** Providers whose catalogue model IDs are not safe deployment defaults. */
export function requiresExplicitModelSelection(
  provider: ModelProvider | undefined,
): boolean {
  // Both Azure providers let customers name deployments independently of the
  // underlying model family, so a catalogue row such as `gpt-4.1` is only a
  // suggestion. For Foundry this is stronger than a preference: its catalogue
  // listing is of models available to deploy, not of models deployed, so
  // auto-selecting from it picks something that usually is not callable.
  return provider === "azure" || provider === "azure_ai";
}

// Preferred auto-select order for the LLM onboarding step. Only a preference:
// providers this run mode hides are dropped, and anything the API returns that
// is not listed here is appended in API order.
export const LLM_PROVIDER_ORDER: ModelProvider[] = [
  "anthropic",
  "openai",
  "watsonx",
  "ollama",
];

// Preferred auto-select order for the embedding onboarding step
export const EMBEDDING_PROVIDER_ORDER: ModelProvider[] = [
  "openai",
  "watsonx",
  "ollama",
];

/**
 * `preferred` first (skipping anything not in `available`), then whatever else
 * `available` holds, in the order the backend returned it.
 */
export function orderProviders(
  available: ModelProvider[],
  preferred: ModelProvider[],
): ModelProvider[] {
  const offered = new Set(available);
  const ranked = preferred.filter((provider) => offered.has(provider));
  const seen = new Set(ranked);
  return [...ranked, ...available.filter((provider) => !seen.has(provider))];
}

export function isProviderConfigured(
  providers: ProviderSettings | undefined,
  provider: string,
): boolean {
  if (!providers) return false;
  if (providers.custom?.[provider]?.configured === true) {
    return true;
  }
  const legacy = providers as Record<
    string,
    { configured?: boolean } | undefined
  >;
  return legacy[provider]?.configured === true;
}

/**
 * A model provider can only be removed if it is currently configured and
 * there is at least one other configured provider that has an embedding model
 * (which excludes Anthropic, as it does not provide embeddings).
 */
export function canRemoveProvider(
  providers: ProviderSettings | undefined,
  provider: string,
): boolean {
  if (!isProviderConfigured(providers, provider)) {
    return false;
  }

  // Check custom providers (includes configured catalog providers and legacy mirrors)
  for (const [key, value] of Object.entries(providers?.custom ?? {})) {
    if (key !== provider && key !== "anthropic" && value?.configured === true) {
      return true;
    }
  }

  // Check top-level legacy providers as fallback
  if (provider !== "openai" && providers?.openai?.configured === true) {
    return true;
  }
  if (provider !== "watsonx" && providers?.watsonx?.configured === true) {
    return true;
  }
  if (provider !== "ollama" && providers?.ollama?.configured === true) {
    return true;
  }

  return false;
}

export interface ModelOption {
  value: string;
  label: string;
}

export interface ProviderChrome {
  /** Display name; the API's `display_name` wins over the built-in label. */
  name: string;
  logo: (props: React.SVGProps<SVGSVGElement>) => React.ReactNode;
  logoColor: string;
  logoBgColor: string;
  /** Onboarding tabs invert some marks; defaults to the card colours. */
  tabLogoColor?: string;
  tabLogoBgColor?: string;
}

/** Logo and colours for the providers OpenRAG ships chrome for. */
const PROVIDER_CHROME: Record<string, ProviderChrome> = {
  openai: {
    name: "OpenAI",
    logo: OpenAILogo,
    logoColor: "text-black",
    logoBgColor: "bg-white",
  },
  anthropic: {
    name: "Anthropic",
    logo: AnthropicLogo,
    logoColor: "text-[#D97757]",
    logoBgColor: "bg-white",
    tabLogoColor: "text-black",
    tabLogoBgColor: "bg-[#D97757]",
  },
  ollama: {
    name: "Ollama",
    logo: OllamaLogo,
    logoColor: "text-black",
    logoBgColor: "bg-white",
  },
  watsonx: {
    name: "IBM watsonx.ai",
    logo: IBMLogo,
    logoColor: "text-white",
    logoBgColor: "bg-[#1063FE]",
  },
  // Same product on a Cloud Pak for Data cluster, so the same mark. The two
  // cards are told apart by the display name the API sends.
  watsonx_onprem: {
    name: "IBM watsonx.ai (on-prem)",
    logo: IBMLogo,
    logoColor: "text-white",
    logoBgColor: "bg-[#1063FE]",
  },
  // Models served by KServe + vLLM inside the customer's own OpenShift
  // cluster. One card, though it is two InferenceServices behind the scenes.
  rhoai: {
    name: "Red Hat OpenShift AI",
    logo: OpenShiftAILogo,
    logoColor: "text-white",
    logoBgColor: "bg-[#EE0000]",
  },
  // Microsoft draws the two Azure model services differently, and neither is
  // the generic Azure logo. AiFoundryLogo paints its own gradient, so
  // logoColor does nothing for it and the tile stays white.
  azure_ai: {
    name: "Azure AI Foundry",
    logo: AiFoundryLogo,
    logoColor: "text-black",
    logoBgColor: "bg-white",
  },
  azure: {
    name: "Azure OpenAI",
    logo: AzureOpenAILogo,
    logoColor: "text-[#0078D4]",
    logoBgColor: "bg-white",
  },
  local: {
    name: "Local",
    logo: GenericProviderLogo,
    logoColor: "text-muted-foreground",
    logoBgColor: "bg-white",
  },
};

/**
 * Chrome for `provider`. A provider the config file adds but the frontend has
 * no artwork for still renders, under the display name the API gave it.
 */
export function getProviderChrome(
  provider: ModelProvider,
  displayName?: string,
): ProviderChrome {
  const known = PROVIDER_CHROME[provider];
  if (known) {
    return displayName ? { ...known, name: displayName } : known;
  }
  return {
    name: displayName || provider,
    logo: GenericProviderLogo,
    logoColor: "text-black",
    logoBgColor: "bg-white",
  };
}

// Helper function to get model logo based on provider or model name
export function getModelLogo(modelValue: string, provider?: string) {
  // First check by provider
  if (provider === "openai") {
    return <OpenAILogo className="w-4 h-4" />;
  } else if (provider === "anthropic") {
    return <AnthropicLogo className="w-4 h-4" />;
  } else if (provider === "ollama") {
    return <OllamaLogo className="w-4 h-4" />;
  } else if (provider === "watsonx" || provider === "watsonx_onprem") {
    return <IBMLogo className="w-4 h-4" />;
  } else if (provider === "rhoai") {
    return <OpenShiftAILogo className="w-4 h-4" />;
  } else if (provider === "azure") {
    return <AzureOpenAILogo className="w-4 h-4" />;
  } else if (provider === "azure_ai") {
    return <AiFoundryLogo className="w-4 h-4" />;
  } else if (provider === "local") {
    return (
      <svg
        xmlns="http://www.w3.org/2000/svg"
        viewBox="0 0 24 24"
        fill="none"
        stroke="currentColor"
        strokeWidth="2"
        strokeLinecap="round"
        strokeLinejoin="round"
        className="w-4 h-4 text-muted-foreground"
      >
        <rect x="4" y="4" width="16" height="16" rx="2" />
        <rect x="9" y="9" width="6" height="6" />
        <path d="M9 1v3" />
        <path d="M15 1v3" />
        <path d="M9 20v3" />
        <path d="M15 20v3" />
        <path d="M20 9h3" />
        <path d="M20 15h3" />
        <path d="M1 9h3" />
        <path d="M1 15h3" />
      </svg>
    );
  } else if (provider) {
    return (
      <svg
        xmlns="http://www.w3.org/2000/svg"
        viewBox="0 0 24 24"
        fill="none"
        stroke="currentColor"
        strokeWidth="2"
        strokeLinecap="round"
        strokeLinejoin="round"
        className="w-4 h-4 text-muted-foreground"
      >
        <path d="M21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z" />
        <polyline points="3.27 6.96 12 12.01 20.73 6.96" />
        <line x1="12" y1="22.08" x2="12" y2="12" />
      </svg>
    );
  }

  // Fallback to model name analysis
  if (modelValue.includes("gpt") || modelValue.includes("text-embedding")) {
    return <OpenAILogo className="w-4 h-4" />;
  } else if (modelValue.includes("llama") || modelValue.includes("ollama")) {
    return <OllamaLogo className="w-4 h-4" />;
  } else if (
    modelValue.includes("granite") ||
    modelValue.includes("slate") ||
    modelValue.includes("ibm")
  ) {
    return <IBMLogo className="w-4 h-4" />;
  }

  return <OpenAILogo className="w-4 h-4" />; // Default to OpenAI logo
}

// Offline fallbacks when live /api/models/* returns empty.
// Include current preferred defaults AND older models that are still functional.
// Live provider lists remain the real catalog when the API is reachable.
export function getFallbackModels(provider: ModelProvider) {
  switch (provider) {
    case "openai":
      return {
        language: [
          // GPT-5.6 family (current frontier)
          { value: "gpt-5.6", label: "GPT-5.6" },
          { value: "gpt-5.6-sol", label: "GPT-5.6 Sol" },
          { value: "gpt-5.6-terra", label: "GPT-5.6 Terra" },
          { value: "gpt-5.6-luna", label: "GPT-5.6 Luna" },
          // GPT-5.5
          { value: "gpt-5.5", label: "GPT-5.5" },
          { value: "gpt-5.5-pro", label: "GPT-5.5 Pro" },
          // GPT-5.4 and earlier (still functional)
          { value: "gpt-5.4", label: "GPT-5.4" },
          { value: "gpt-5.4-mini", label: "GPT-5.4 Mini" },
          { value: "gpt-5.4-nano", label: "GPT-5.4 Nano" },
          { value: "gpt-5.4-pro", label: "GPT-5.4 Pro" },
          { value: "gpt-5.3-codex", label: "GPT-5.3 Codex" },
          { value: "gpt-5.2", label: "GPT-5.2" },
          { value: "gpt-5.1", label: "GPT-5.1" },
          { value: "gpt-5", label: "GPT-5" },
          { value: "gpt-5-mini", label: "GPT-5 Mini" },
          { value: "gpt-5-nano", label: "GPT-5 Nano" },
          { value: "gpt-4.1", label: "GPT-4.1" },
          { value: "gpt-4.1-mini", label: "GPT-4.1 Mini" },
          { value: "gpt-4o", label: "GPT-4o" },
          { value: "gpt-4o-mini", label: "GPT-4o Mini" },
          { value: "o3", label: "o3" },
          { value: "o3-pro", label: "o3 Pro" },
          { value: "o4-mini", label: "o4 Mini" },
          { value: "o4-mini-high", label: "o4 Mini High" },
        ],
        embedding: [
          { value: "text-embedding-3-large", label: "text-embedding-3-large" },
          { value: "text-embedding-3-small", label: "text-embedding-3-small" },
          { value: "text-embedding-ada-002", label: "text-embedding-ada-002" },
        ],
      };
    case "anthropic":
      return {
        language: [
          // Claude 5 family (current)
          { value: "claude-fable-5", label: "Claude Fable 5" },
          { value: "claude-opus-5", label: "Claude Opus 5" },
          { value: "claude-sonnet-5", label: "Claude Sonnet 5" },
          // Claude 4.x (still functional)
          { value: "claude-opus-4-8", label: "Claude Opus 4.8" },
          { value: "claude-opus-4-7", label: "Claude Opus 4.7" },
          { value: "claude-opus-4-6", label: "Claude Opus 4.6" },
          { value: "claude-sonnet-4-6", label: "Claude Sonnet 4.6" },
          { value: "claude-opus-4-5-20251101", label: "Claude Opus 4.5" },
          { value: "claude-sonnet-4-5-20250929", label: "Claude Sonnet 4.5" },
          { value: "claude-haiku-4-5-20251001", label: "Claude Haiku 4.5" },
        ],
      };
    case "ollama":
      return {
        // Tool-calling capable recommendations only (agent requires tools)
        language: [
          { value: "gpt-oss", label: "gpt-oss" },
          { value: "mistral-nemo", label: "mistral-nemo" },
          { value: "llama3.1", label: "Llama 3.1" },
          { value: "qwen2.5", label: "Qwen 2.5" },
        ],
        embedding: [
          { value: "nomic-embed-text", label: "Nomic Embed Text" },
          { value: "mxbai-embed-large", label: "MxBai Embed Large" },
        ],
      };
    case "watsonx":
      // No stable static IDs — live list is required for watsonx.
      return { language: [], embedding: [] };
    default:
      return {
        language: [
          { value: "gpt-5.6-luna", label: "GPT-5.6 Luna" },
          { value: "gpt-5.4-mini", label: "GPT-5.4 Mini" },
          { value: "gpt-4o", label: "GPT-4o" },
          { value: "gpt-4o-mini", label: "GPT-4o Mini" },
        ],
        embedding: [
          { value: "text-embedding-3-small", label: "text-embedding-3-small" },
          { value: "text-embedding-3-large", label: "text-embedding-3-large" },
        ],
      };
  }
}