feat: expand assistant providers and polish experience

This commit is contained in:
ajnart committed 2026-08-14 11:32:10 +02:00
1 parent 5f3d676af0
commit c0445cdca2
12 files changed
+438 -70

No files matched your search

+35 -9
View File
@@ -7,12 +7,13 @@ import { decryptSecret, encryptSecret } from "@homarr/common/server";
import { and, desc, eq, inArray } from "@homarr/db";
import type { Database } from "@homarr/db";
import { assistantConfigurations, assistantMessages, assistantThreads } from "@homarr/db/schema";
import { assistantProviderIds, assistantProviderPresets, assistantProviderRequiresApiKey } from "@homarr/definitions";
import { createTRPCRouter, permissionRequiredProcedure, protectedProcedure } from "../trpc";
const adminProcedure = permissionRequiredProcedure.requiresPermission("admin");
const configurationId = "default";
const providerSchema = z.enum(["openrouter", "openai", "ollama", "lm-studio", "custom"]);
const providerSchema = z.enum(assistantProviderIds);
const modelSchema = z.object({
id: z.string(),
@@ -27,12 +28,16 @@ const modelSchema = z.object({
type CompatibleModel = {
id?: unknown;
name?: unknown;
display_name?: unknown;
model?: unknown;
description?: unknown;
context_length?: unknown;
max_context_length?: unknown;
max_input_tokens?: unknown;
supported_parameters?: unknown;
architecture?: { output_modalities?: unknown };
pricing?: { prompt?: unknown; completion?: unknown };
capabilities?: { function_calling?: unknown };
};
type AssistantConfiguration = typeof assistantConfigurations.$inferSelect;
@@ -108,7 +113,13 @@ const decryptCustomHeaders = (encryptedHeaders: `${string}.${string}` | null) =>
const getProviderHeaders = (configuration: AssistantConfiguration) => {
const headers: Record<string, string> = {};
if (configuration.encryptedApiKey) {
headers.Authorization = `Bearer ${decryptSecret(configuration.encryptedApiKey)}`;
const apiKey = decryptSecret(configuration.encryptedApiKey);
if (assistantProviderPresets[configuration.provider].discoveryAuthentication === "anthropic") {
headers["X-Api-Key"] = apiKey;
headers["anthropic-version"] = "2023-06-01";
} else {
headers.Authorization = `Bearer ${apiKey}`;
}
}
if (configuration.provider === "openrouter") {
headers["HTTP-Referer"] ??= "https://homarr.dev";
@@ -149,13 +160,13 @@ const fetchModelsAsync = async (configuration: AssistantConfiguration) => {
});
}
let body: { data?: CompatibleModel[]; models?: CompatibleModel[] };
let body: { data?: CompatibleModel[]; models?: CompatibleModel[] } | CompatibleModel[];
try {
body = (await response.json()) as typeof body;
} catch {
throw new TRPCError({ code: "BAD_GATEWAY", message: "The model endpoint returned invalid JSON." });
}
const models = body.data ?? body.models ?? [];
const models = Array.isArray(body) ? body : (body.data ?? body.models ?? []);
return models
.filter((model) => {
if (configuration.provider !== "openrouter") return true;
@@ -168,16 +179,31 @@ const fetchModelsAsync = async (configuration: AssistantConfiguration) => {
.flatMap((model) => {
const id = typeof model.id === "string" ? model.id : typeof model.model === "string" ? model.model : null;
if (!id) return [];
const name = typeof model.name === "string" ? model.name : id;
const name =
typeof model.name === "string" ? model.name : typeof model.display_name === "string" ? model.display_name : id;
const contextLength =
typeof model.context_length === "number"
? model.context_length
: typeof model.max_context_length === "number"
? model.max_context_length
: typeof model.max_input_tokens === "number"
? model.max_input_tokens
: null;
const toolSupport =
configuration.provider === "openrouter" ||
model.capabilities?.function_calling === true ||
configuration.provider === "anthropic"
? ("confirmed" as const)
: ("unknown" as const);
return [
{
id,
name,
description: typeof model.description === "string" ? model.description : null,
contextLength: typeof model.context_length === "number" ? model.context_length : null,
contextLength,
promptPrice: typeof model.pricing?.prompt === "string" ? model.pricing.prompt : null,
completionPrice: typeof model.pricing?.completion === "string" ? model.pricing.completion : null,
toolSupport: configuration.provider === "openrouter" ? ("confirmed" as const) : ("unknown" as const),
toolSupport,
},
];
})
@@ -204,7 +230,7 @@ export const assistantRouter = createTRPCRouter({
})
.query(async ({ ctx }) => {
const configuration = await getConfigurationAsync(ctx.db);
const requiresApiKey = configuration?.provider === "openrouter" || configuration?.provider === "openai";
const requiresApiKey = configuration ? assistantProviderRequiresApiKey(configuration.provider) : false;
return {
enabled: Boolean(
configuration?.enabled && configuration.modelId && (!requiresApiKey || configuration.encryptedApiKey),
@@ -318,7 +344,7 @@ export const assistantRouter = createTRPCRouter({
if (!configuration) {
throw new TRPCError({ code: "PRECONDITION_FAILED", message: "Save a provider connection first." });
}
const requiresApiKey = configuration.provider === "openrouter" || configuration.provider === "openai";
const requiresApiKey = assistantProviderRequiresApiKey(configuration.provider);
if (input.enabled && requiresApiKey && !configuration.encryptedApiKey) {
throw new TRPCError({ code: "PRECONDITION_FAILED", message: "This provider requires an API key." });
}
@@ -0,0 +1,24 @@
import { describe, expect, test } from "vitest";
import { assistantProviderIds, assistantProviderPresets, assistantProviderRequiresApiKey } from "@homarr/definitions";
describe("assistant provider presets", () => {
test("defines one complete preset for every provider", () => {
expect(Object.keys(assistantProviderPresets)).toEqual(assistantProviderIds);
expect(new Set(assistantProviderIds).size).toBe(assistantProviderIds.length);
});
test.each(assistantProviderIds.filter((provider) => provider !== "custom"))(
"%s has a valid default endpoint",
(provider) => {
expect(() => new URL(assistantProviderPresets[provider].baseUrl)).not.toThrow();
expect(assistantProviderPresets[provider].modelDiscoveryPath).toMatch(/^\/[^/]/);
},
);
test("requires credentials for hosted providers but not local or custom endpoints", () => {
for (const provider of assistantProviderIds) {
expect(assistantProviderRequiresApiKey(provider)).toBe(assistantProviderPresets[provider].category === "hosted");
}
});
});
+14 -1
View File
@@ -485,7 +485,20 @@ export const assistantConfigurations = mysqlTable("assistant_configuration", {
id: varchar({ length: 64 }).notNull().primaryKey().default("default"),
enabled: boolean().notNull().default(false),
provider: varchar({ length: 32 })
.$type<"openrouter" | "openai" | "ollama" | "lm-studio" | "custom">()
.$type<
| "openrouter"
| "openai"
| "anthropic"
| "google-gemini"
| "xai"
| "groq"
| "mistral"
| "deepseek"
| "together"
| "ollama"
| "lm-studio"
| "custom"
>()
.notNull()
.default("openrouter"),
baseUrl: varchar({ length: 2048 }).notNull().default("https://openrouter.ai/api/v1"),
+14 -1
View File
@@ -484,7 +484,20 @@ export const assistantConfigurations = pgTable("assistant_configuration", {
id: varchar({ length: 64 }).notNull().primaryKey().default("default"),
enabled: boolean().notNull().default(false),
provider: varchar({ length: 32 })
.$type<"openrouter" | "openai" | "ollama" | "lm-studio" | "custom">()
.$type<
| "openrouter"
| "openai"
| "anthropic"
| "google-gemini"
| "xai"
| "groq"
| "mistral"
| "deepseek"
| "together"
| "ollama"
| "lm-studio"
| "custom"
>()
.notNull()
.default("openrouter"),
baseUrl: varchar({ length: 2048 }).notNull().default("https://openrouter.ai/api/v1"),
+17 -1
View File
@@ -468,7 +468,23 @@ export const serverSettings = sqliteTable("serverSetting", {
export const assistantConfigurations = sqliteTable("assistant_configuration", {
id: text().notNull().primaryKey().default("default"),
enabled: int({ mode: "boolean" }).notNull().default(false),
provider: text().$type<"openrouter" | "openai" | "ollama" | "lm-studio" | "custom">().notNull().default("openrouter"),
provider: text()
.$type<
| "openrouter"
| "openai"
| "anthropic"
| "google-gemini"
| "xai"
| "groq"
| "mistral"
| "deepseek"
| "together"
| "ollama"
| "lm-studio"
| "custom"
>()
.notNull()
.default("openrouter"),
baseUrl: text().notNull().default("https://openrouter.ai/api/v1"),
modelDiscoveryPath: text().default("/models"),
encryptedApiKey: text().$type<`${string}.${string}`>(),
+115
View File
@@ -0,0 +1,115 @@
export const assistantProviderIds = [
"openrouter",
"openai",
"anthropic",
"google-gemini",
"xai",
"groq",
"mistral",
"deepseek",
"together",
"ollama",
"lm-studio",
"custom",
] as const;
export type AssistantProvider = (typeof assistantProviderIds)[number];
export type AssistantProviderCategory = "hosted" | "local" | "custom";
interface AssistantProviderPreset {
baseUrl: string;
modelDiscoveryPath: string | null;
requiresApiKey: boolean;
category: AssistantProviderCategory;
discoveryAuthentication: "bearer" | "anthropic";
}
export const assistantProviderPresets = {
openrouter: {
baseUrl: "https://openrouter.ai/api/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
openai: {
baseUrl: "https://api.openai.com/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
anthropic: {
baseUrl: "https://api.anthropic.com/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "anthropic",
},
"google-gemini": {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
xai: {
baseUrl: "https://api.x.ai/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
groq: {
baseUrl: "https://api.groq.com/openai/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
mistral: {
baseUrl: "https://api.mistral.ai/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
deepseek: {
baseUrl: "https://api.deepseek.com",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
together: {
baseUrl: "https://api.together.xyz/v1",
modelDiscoveryPath: "/models",
requiresApiKey: true,
category: "hosted",
discoveryAuthentication: "bearer",
},
ollama: {
baseUrl: "http://localhost:11434/v1",
modelDiscoveryPath: "/models",
requiresApiKey: false,
category: "local",
discoveryAuthentication: "bearer",
},
"lm-studio": {
baseUrl: "http://localhost:1234/v1",
modelDiscoveryPath: "/models",
requiresApiKey: false,
category: "local",
discoveryAuthentication: "bearer",
},
custom: {
baseUrl: "",
modelDiscoveryPath: "/models",
requiresApiKey: false,
category: "custom",
discoveryAuthentication: "bearer",
},
} as const satisfies Record<AssistantProvider, AssistantProviderPreset>;
export const assistantProviderRequiresApiKey = (provider: AssistantProvider) =>
assistantProviderPresets[provider].requiresApiKey;
+1
View File
@@ -18,3 +18,4 @@ export * from "./hotkeys";
export * from "./docker-integration-match";
export * from "./integration-url-template";
export * from "./release-provider";
export * from "./assistant";
+57 -1
View File
@@ -1995,11 +1995,30 @@
"openHistory": "Open conversation history",
"emptyTitle": "What can I help with?",
"emptyDescription": "Ask about your Homarr setup, inspect live instance data, or approve actions when you want me to make a change.",
"suggestions": {
"health": {
"label": "Check service health",
"prompt": "Check my integrations and summarize anything that needs attention."
},
"explore": {
"label": "Explore my Homarr",
"prompt": "Show me what I can view and manage in this Homarr instance."
},
"media": {
"label": "Find media to request",
"prompt": "Help me find a movie or series to request."
},
"command": {
"label": "Open the command menu",
"prompt": "Open the Homarr command menu for me."
}
},
"composerPlaceholder": "Ask Homarr Assistant…",
"stop": "Stop response",
"send": "Send message",
"copy": "Copy response",
"regenerate": "Regenerate response",
"responseError": "The response stopped unexpectedly. Try again, or ask an administrator to verify the model endpoint.",
"scrollToLatest": "Scroll to latest",
"approvalRequired": "Approval required",
"complete": "Complete",
@@ -5852,6 +5871,11 @@
},
"provider": {
"title": "Provider",
"groups": {
"hosted": "Hosted providers",
"local": "Local providers",
"custom": "Custom"
},
"options": {
"openrouter": {
"label": "OpenRouter",
@@ -5861,6 +5885,34 @@
"label": "OpenAI",
"description": "OpenAI Chat Completions through the official API endpoint."
},
"anthropic": {
"label": "Anthropic Claude",
"description": "Claude through Anthropic's OpenAI SDK compatibility endpoint."
},
"google-gemini": {
"label": "Google Gemini",
"description": "Gemini through Google's OpenAI-compatible API endpoint."
},
"xai": {
"label": "xAI",
"description": "Grok models through xAI's OpenAI-compatible API."
},
"groq": {
"label": "Groq",
"description": "Fast hosted inference through Groq's OpenAI-compatible API."
},
"mistral": {
"label": "Mistral AI",
"description": "Mistral models through the official API."
},
"deepseek": {
"label": "DeepSeek",
"description": "DeepSeek models through its OpenAI-compatible API."
},
"together": {
"label": "Together AI",
"description": "Hosted open models through Together's OpenAI-compatible API."
},
"ollama": {
"label": "Ollama",
"description": "A local or network Ollama server using its OpenAI-compatible API."
@@ -5915,7 +5967,11 @@
"discoveryPathDescription": "Appended to the API base URL. Leave blank to disable discovery and use a manual model ID.",
"manual": "Enter a model ID manually or save the connection to discover models.",
"manualFallback": "Discovery is unavailable. You can still enter a model ID manually.",
"discovered": "Discovered {count} models. Tool support depends on the selected endpoint and model."
"discovered": "Discovered {count} models. Tool support depends on the selected endpoint and model.",
"discoveryFailed": "Model discovery did not complete",
"context": "{count} token context",
"toolsConfirmed": "Tools advertised",
"toolsUnknown": "Verify tool support"
},
"enabled": {
"label": "Enable Homarr Assistant",