Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(ai): simplify adapter configuration (#1278)

Corentin Thomasset5162c6d50330
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.factory.schemas.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.factory.schemas.ts
deleted file mode 100644
index c39012db..00000000
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.factory.schemas.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-import * as v from 'valibot';
-import { ADAPTER_MODEL_SEPARATOR } from '../ai.constants';
-
-export const adapterIdSchema = v.pipe(
- v.string(),
- v.check(
- (id) => !id.includes(ADAPTER_MODEL_SEPARATOR),
- `Adapter id cannot contain "${ADAPTER_MODEL_SEPARATOR}" as it is reserved for separating adapter id and model name in model identifiers.`,
- ),
-);
-
-export function createAdapterConfigSchema<
- AdapterName extends string,
- Schema extends Record<string, v.GenericSchema>,
->(adapterName: AdapterName, schema: Schema) {
- return v.object({
- id: adapterIdSchema,
- adapter: v.literal(adapterName),
- ...schema,
- });
-}
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts
index 69e859e9..68e51038 100644
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts
+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts
@@ -1,8 +1,13 @@
-import { OPENAI_COMPATIBLE_ADAPTER_NAME } from './openai-compatible/openai-compatible.ai-adapters.constants';
-import { getOpenAiCompatibleModelAdapter } from './openai-compatible/openai-compatible.ai-adapters';
+import { objectKeys } from '@papra/std';
+import type { AiAdapterFactory } from './ai-adapters.types';
+import { buildOllamaAdapter, OLLAMA_ADAPTER_NAME } from './ollama/ollama.ai-adapters';
+import { buildOpenAiAdapter, OPENAI_ADAPTER_NAME } from './openai/openai.ai-adapters';
export const modelAdapterFactories = {
- [OPENAI_COMPATIBLE_ADAPTER_NAME]: getOpenAiCompatibleModelAdapter,
-};
+ [OLLAMA_ADAPTER_NAME]: buildOllamaAdapter,
+ [OPENAI_ADAPTER_NAME]: buildOpenAiAdapter,
+} satisfies Record<string, AiAdapterFactory>;
-export type ModelAdapterNames = keyof typeof modelAdapterFactories;
+export const modelAdapterNames = objectKeys(modelAdapterFactories);
+
+export type ModelAdapterNames = (typeof modelAdapterNames)[number];
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.test.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.test.ts
deleted file mode 100644
index 85799a5b..00000000
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.test.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { aiModelAdapterConfigListSchema } from './ai-adapters.schemas';
-import * as v from 'valibot';
-
-describe('ai.schemas', () => {
- describe('aiModelAdapterConfigListSchema', () => {
- test('model config ids should be unique', () => {
- expect(() =>
- v.parse(aiModelAdapterConfigListSchema, [
- {
- id: 'model1',
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- {
- id: 'model1', // Duplicate ID
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- ]),
- ).toThrow(
- 'Duplicate AI model adapter IDs are not allowed. Make sure each adapter configuration has a unique "id" field.',
- );
-
- expect(
- v.parse(aiModelAdapterConfigListSchema, [
- {
- id: 'model1',
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- {
- id: 'model2', // Unique ID
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- ]),
- ).toEqual([
- {
- id: 'model1',
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- {
- id: 'model2',
- adapter: 'openai-compatible',
- baseUrl: 'https://api.openai.com/v1',
- apiKey: 'test-api-key',
- },
- ]);
- });
-
- test('empty list should be valid', () => {
- expect(v.parse(aiModelAdapterConfigListSchema, [])).toEqual([]);
- });
- });
-});
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.ts
deleted file mode 100644
index 1fda250e..00000000
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.schemas.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import * as v from 'valibot';
-import { openAiCompatibleAdapterConfigSchema } from './openai-compatible/openai-compatible.ai-adapters.schemas';
-
-export const aiModelAdapterConfigSchema = v.variant('adapter', [
- openAiCompatibleAdapterConfigSchema,
-]);
-
-export type AiModelAdapterConfig = v.InferOutput<typeof aiModelAdapterConfigSchema>;
-export type AiModelAdapterListConfig = AiModelAdapterConfig[];
-
-export const aiModelAdapterConfigListSchema = v.pipe(
- v.array(aiModelAdapterConfigSchema),
- v.check((list) => {
- const ids = new Set<string>();
- for (const config of list) {
- if (ids.has(config.id)) {
- return false;
- }
- ids.add(config.id);
- }
- return true;
- }, 'Duplicate AI model adapter IDs are not allowed. Make sure each adapter configuration has a unique "id" field.'),
-);
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts
new file mode 100644
index 00000000..293fde05
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts
@@ -0,0 +1,9 @@
+import type { AnyTextAdapter } from '@tanstack/ai';
+import type { Config } from '../../config/config.types';
+
+export type AiAdapter = {
+ name: string;
+ getTextAdapter: (args: { modelName: string }) => AnyTextAdapter;
+};
+
+export type AiAdapterFactory = (args: { config: Config }) => AiAdapter;
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.test.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.test.ts
deleted file mode 100644
index ff04c27e..00000000
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.test.ts
+++ /dev/null
@@ -1,95 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { OPENAI_COMPATIBLE_ADAPTER_NAME } from './openai-compatible/openai-compatible.ai-adapters.constants';
-import type { AiModelAdapterConfig } from './ai-adapters.schemas';
-import { resolveModelAdapter } from './ai-adapters.usecases';
-
-function createOpenAiCompatibleAdapterConfig(
- overrides: Partial<AiModelAdapterConfig> = {},
-): AiModelAdapterConfig {
- return {
- id: 'adapter-1',
- adapter: OPENAI_COMPATIBLE_ADAPTER_NAME,
- baseUrl: 'https://example.com',
- apiKey: 'sk-test',
- ...overrides,
- };
-}
-
-describe('ai-adapters.usecases', () => {
- describe('resolveModelAdapter', () => {
- test('resolves the only configured adapter when no adapterId is provided', () => {
- const { adapter } = resolveModelAdapter({
- model: { modelName: 'gpt-4o' },
- adaptersConfig: [createOpenAiCompatibleAdapterConfig()],
- });
-
- expect(adapter.model).toBe('gpt-4o');
- });
-
- test('resolves the adapter matching the given adapterId when multiple are configured', () => {
- const { adapter } = resolveModelAdapter({
- model: { modelName: 'gpt-4o-mini', adapterId: 'second' },
- adaptersConfig: [
- createOpenAiCompatibleAdapterConfig({
- id: 'first',
- baseUrl: 'https://first.example.com',
- }),
- createOpenAiCompatibleAdapterConfig({
- id: 'second',
- baseUrl: 'https://second.example.com',
- }),
- ],
- });
-
- // The matching adapter is resolved and the requested model name is forwarded to it.
- expect(adapter.model).toBe('gpt-4o-mini');
- });
-
- test('throws when no adapters are configured', () => {
- expect(() =>
- resolveModelAdapter({
- model: { modelName: 'gpt-4o' },
- adaptersConfig: [],
- }),
- ).toThrow('No adapters configured');
- });
-
- test('throws when multiple adapters are configured but no adapterId is provided', () => {
- expect(() =>
- resolveModelAdapter({
- model: { modelName: 'gpt-4o' },
- adaptersConfig: [
- createOpenAiCompatibleAdapterConfig({ id: 'first' }),
- createOpenAiCompatibleAdapterConfig({ id: 'second' }),
- ],
- }),
- ).toThrow('Multiple adapters configured, but no adapterId provided');
- });
-
- test('throws when the provided adapterId does not match any configured adapter', () => {
- expect(() =>
- resolveModelAdapter({
- model: { modelName: 'gpt-4o', adapterId: 'unknown' },
- adaptersConfig: [
- createOpenAiCompatibleAdapterConfig({ id: 'first' }),
- createOpenAiCompatibleAdapterConfig({ id: 'second' }),
- ],
- }),
- ).toThrow('Adapter config not found for adapterId: unknown');
- });
-
- test('throws when no factory is registered for the resolved adapter', () => {
- const adapterConfig = {
- ...createOpenAiCompatibleAdapterConfig(),
- adapter: 'unregistered-adapter',
- } as unknown as AiModelAdapterConfig;
-
- expect(() =>
- resolveModelAdapter({
- model: { modelName: 'gpt-4o' },
- adaptersConfig: [adapterConfig],
- }),
- ).toThrow('Adapter factory not found');
- });
- });
-});
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.ts
index 4b53819e..01b62f56 100644
--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.ts
+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.usecases.ts
@@ -1,54 +1,33 @@
-import { isNil } from '../../shared/utils';
-import type { ModelConfig } from '../ai.type';
+import type { AnyTextAdapter } from '@tanstack/ai';
+import type { Config } from '../../config/config.types';
+import { parseModelId } from '../ai.schemas.models';
import { modelAdapterFactories } from './ai-adapters.registry';
-import type { AiModelAdapterListConfig } from './ai-adapters.schemas';
+import type { ModelAdapterNames } from './ai-adapters.registry';
+import { createError } from '../../shared/errors/errors';
-export function getAdapterConfig({
- adapterId,
- adaptersConfig,
+export function resolveTextAdapter({
+ modelId,
+ config,
}: {
- adapterId?: string;
- adaptersConfig: AiModelAdapterListConfig;
-}) {
- const adaptersCount = adaptersConfig.length;
-
- if (adaptersCount === 0) {
- throw new Error('No adapters configured');
- }
-
- if (adaptersCount > 1 && isNil(adapterId)) {
- throw new Error('Multiple adapters configured, but no adapterId provided');
- }
-
- if (adaptersCount === 1 && isNil(adapterId)) {
- return { adapterConfig: adaptersConfig[0]! };
- }
-
- const adapterConfig = adaptersConfig.find((adapter) => adapter.id === adapterId);
-
- if (!adapterConfig) {
- throw new Error(`Adapter config not found for adapterId: ${adapterId}`);
+ modelId: string;
+ config: Config;
+}): AnyTextAdapter {
+ const { modelName, adapterId } = parseModelId(modelId);
+
+ const adapterName = adapterId ?? config.ai.defaultAdapterName;
+
+ const adapterFactory = modelAdapterFactories[adapterName as ModelAdapterNames];
+
+ if (!adapterFactory) {
+ throw createError({
+ code: 'ai.adapterNotFound',
+ message: `No adapter found for adapter name "${adapterName}"`,
+ statusCode: 500,
+ isInternal: true,
+ });
}
- return { adapterConfig };
-}
-
-export function resolveModelAdapter({
- model,
- adaptersConfig,
-}: {
- model: ModelConfig;
- adaptersConfig: AiModelAdapterListConfig;
-}) {
- const { modelName, adapterId } = model;
-
- const { adapterConfig } = getAdapterConfig({ adapterId, adaptersConfig });
-
- const factory = modelAdapterFactories[adapterConfig.adapter];
-
- if (!factory) {
- throw new Error(`Adapter factory not found for adapterId: ${adapterId}`);
- }
+ const adapter = adapterFactory({ config });
- return factory({ modelName, adapterConfig });
+ return adapter.getTextAdapter({ modelName });
}
diff --git a/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.config.ts b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.config.ts
new file mode 100644
index 00000000..215d5e06
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.config.ts
@@ -0,0 +1,20 @@
+import { urlSchema } from '../../../config/config.schemas';
+import type { AppConfigDefinition } from '../../../config/config.types';
+import * as v from 'valibot';
+
+export const ollamaAdapterConfig = {
+ baseUrl: {
+ doc: 'Base URL for the Ollama API',
+ schema: urlSchema,
+ env: 'OLLAMA_BASE_URL',
+ default: 'http://localhost:11434/v1',
+ showInDocumentation: false,
+ },
+ apiKey: {
+ doc: 'API key for the Ollama API',
+ schema: v.string(),
+ env: 'OLLAMA_API_KEY',
+ default: 'ollama',
+ showInDocumentation: false,
+ },
+} as const satisfies AppConfigDefinition;
diff --git a/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts
new file mode 100644
index 00000000..ee376e5d
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts
@@ -0,0 +1,15 @@
+import type { Config } from '../../../config/config.types';
+import type { AiAdapter } from '../ai-adapters.types';
+import { buildOpenAiCompatibleTextAdapter } from '../openai/openai-compatible.ai-adapters';
+
+export const OLLAMA_ADAPTER_NAME = 'ollama';
+
+export function buildOllamaAdapter({ config }: { config: Config }): AiAdapter {
+ const adapterConfig = config.ai.adapters.ollama;
+
+ return {
+ name: OLLAMA_ADAPTER_NAME,
+
+ getTextAdapter: buildOpenAiCompatibleTextAdapter(adapterConfig),
+ };
+}
diff --git a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.constants.ts b/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.constants.ts
deleted file mode 100644
index 0e180fb4..00000000
--- a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.constants.ts
+++ /dev/null
@@ -1 +0,0 @@
-export const OPENAI_COMPATIBLE_ADAPTER_NAME = 'openai-compatible';
diff --git a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.schemas.ts b/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.schemas.ts
deleted file mode 100644
index 94c876f4..00000000
--- a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.schemas.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-import * as v from 'valibot';
-import { createAdapterConfigSchema } from '../ai-adapters.factory.schemas';
-import { OPENAI_COMPATIBLE_ADAPTER_NAME } from './openai-compatible.ai-adapters.constants';
-
-export const openAiCompatibleAdapterConfigSchema = createAdapterConfigSchema(
- OPENAI_COMPATIBLE_ADAPTER_NAME,
- {
- baseUrl: v.string(),
- apiKey: v.string(),
-
- defaultHeaders: v.optional(v.record(v.string(), v.string())),
- defaultQuery: v.optional(v.record(v.string(), v.string())),
- organization: v.optional(v.string()),
- project: v.optional(v.string()),
- },
-);
-
-export type OpenAiCompatibleAdapterConfig = v.InferOutput<
- typeof openAiCompatibleAdapterConfigSchema
->;
diff --git a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.ts
deleted file mode 100644
index ea2c9d5c..00000000
--- a/apps/papra-server/src/modules/ai/adapters/openai-compatible/openai-compatible.ai-adapters.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-import { openaiCompatibleText } from '@tanstack/ai-openai/compatible';
-import type { OpenAiCompatibleAdapterConfig } from './openai-compatible.ai-adapters.schemas';
-
-export function getOpenAiCompatibleModelAdapter({
- modelName,
- adapterConfig,
-}: {
- modelName: string;
- adapterConfig: OpenAiCompatibleAdapterConfig;
-}) {
- const { baseUrl, ...rest } = adapterConfig;
-
- return {
- adapter: openaiCompatibleText(modelName, {
- baseURL: baseUrl,
- ...rest,
- }),
- };
-}
diff --git a/apps/papra-server/src/modules/ai/adapters/openai/openai-compatible.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/openai/openai-compatible.ai-adapters.ts
new file mode 100644
index 00000000..77de47d6
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/openai/openai-compatible.ai-adapters.ts
@@ -0,0 +1,21 @@
+import { openaiCompatibleText } from '@tanstack/ai-openai/compatible';
+
+export type OpenAiCompatibleAdapterConfig = {
+ baseUrl: string;
+ apiKey: string;
+ defaultHeaders?: Record<string, string>;
+ defaultQuery?: Record<string, string>;
+ organization?: string;
+ project?: string;
+};
+
+export function buildOpenAiCompatibleTextAdapter({
+ baseUrl,
+ ...rest
+}: OpenAiCompatibleAdapterConfig) {
+ return ({ modelName }: { modelName: string }) =>
+ openaiCompatibleText(modelName, {
+ baseURL: baseUrl,
+ ...rest,
+ });
+}
diff --git a/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.config.ts b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.config.ts
new file mode 100644
index 00000000..811751cd
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.config.ts
@@ -0,0 +1,20 @@
+import { urlSchema } from '../../../config/config.schemas';
+import type { AppConfigDefinition } from '../../../config/config.types';
+import * as v from 'valibot';
+
+export const openAiAdapterConfig = {
+ baseUrl: {
+ doc: 'Base URL for the OpenAI API, configure this to use an OpenAI-compatible API like Ollama or OpenRouter',
+ schema: urlSchema,
+ env: 'OPENAI_BASE_URL',
+ default: 'https://api.openai.com/v1',
+ showInDocumentation: false,
+ },
+ apiKey: {
+ doc: 'API key for the OpenAI API, configure this to use an OpenAI-compatible API like Ollama or OpenRouter',
+ schema: v.string(),
+ env: 'OPENAI_API_KEY',
+ default: 'set-me',
+ showInDocumentation: false,
+ },
+} as const satisfies AppConfigDefinition;
diff --git a/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts
new file mode 100644
index 00000000..0b5598cf
--- /dev/null
+++ b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts
@@ -0,0 +1,15 @@
+import type { Config } from '../../../config/config.types';
+import type { AiAdapter } from '../ai-adapters.types';
+import { buildOpenAiCompatibleTextAdapter } from './openai-compatible.ai-adapters';
+
+export const OPENAI_ADAPTER_NAME = 'openai';
+
+export function buildOpenAiAdapter({ config }: { config: Config }): AiAdapter {
+ const adapterConfig = config.ai.adapters.openai;
+
+ return {
+ name: OPENAI_ADAPTER_NAME,
+
+ getTextAdapter: buildOpenAiCompatibleTextAdapter(adapterConfig),
+ };
+}
diff --git a/apps/papra-server/src/modules/ai/ai.config.ts b/apps/papra-server/src/modules/ai/ai.config.ts
index abbfba8c..5471514b 100644
--- a/apps/papra-server/src/modules/ai/ai.config.ts
+++ b/apps/papra-server/src/modules/ai/ai.config.ts
@@ -1,7 +1,10 @@
-import { aiModelIdSchema, aiModelsAdapterConfigSchema } from './ai.schemas';
+import { aiModelIdSchema } from './ai.schemas';
import { booleanishSchema } from '../config/config.schemas';
import type { AppConfigDefinition } from '../config/config.types';
import { AI_DEFAULT_MODEL_ENV_KEY } from './ai.constants';
+import { ollamaAdapterConfig } from './adapters/ollama/ollama.ai-adapters.config';
+import { openAiAdapterConfig } from './adapters/openai/openai.ai-adapters.config';
+import { OPENAI_ADAPTER_NAME } from './adapters/openai/openai.ai-adapters';
export const aiConfig = {
isEnabled: {
@@ -12,14 +15,18 @@ export const aiConfig = {
showInDocumentation: false,
},
adapters: {
- doc: 'List of AI models adapter configurations',
- schema: aiModelsAdapterConfigSchema,
- env: 'AI_ADAPTERS',
- default: [],
+ ollama: ollamaAdapterConfig,
+ openai: openAiAdapterConfig,
+ },
+ defaultAdapterName: {
+ doc: `Default AI adapter to use when no specific adapter is specified in the model id.`,
+ schema: aiModelIdSchema,
+ env: 'AI_DEFAULT_ADAPTER',
+ default: OPENAI_ADAPTER_NAME,
showInDocumentation: false,
},
defaultModelId: {
- doc: 'Default AI model to use when no specific model is specified, the format is <adapterId>://<modelName>, e.g. "ollama://llama3.1:8b", where the <adapterId> is the id of the adapter defined in the AI_ADAPTERS env variable.',
+ doc: 'Default AI model to use when no specific model is specified, the format is <adapterId>://<modelName>, e.g. "ollama://llama3.1:8b". The adapterId can be omitted, like "llama3.1:8b", in which case the default adapter will be used. The modelName is adapter-specific.',
schema: aiModelIdSchema,
env: AI_DEFAULT_MODEL_ENV_KEY,
default: 'unknown',
diff --git a/apps/papra-server/src/modules/ai/ai.schemas.ts b/apps/papra-server/src/modules/ai/ai.schemas.ts
index ee0b68ce..ef485f63 100644
--- a/apps/papra-server/src/modules/ai/ai.schemas.ts
+++ b/apps/papra-server/src/modules/ai/ai.schemas.ts
@@ -1,15 +1,3 @@
import * as v from 'valibot';
-import { aiModelAdapterConfigListSchema } from './adapters/ai-adapters.schemas';
-
-export const aiModelAdaptersEnvConfigSchema = v.pipe(
- v.string(),
- v.parseJson(),
- aiModelAdapterConfigListSchema,
-);
-
-export const aiModelsAdapterConfigSchema = v.union([
- aiModelAdapterConfigListSchema,
- aiModelAdaptersEnvConfigSchema,
-]);
export const aiModelIdSchema = v.string();
diff --git a/apps/papra-server/src/modules/ai/ai.services.ts b/apps/papra-server/src/modules/ai/ai.services.ts
index fd2d6553..c91b02d8 100644
--- a/apps/papra-server/src/modules/ai/ai.services.ts
+++ b/apps/papra-server/src/modules/ai/ai.services.ts
@@ -1,6 +1,5 @@
import type { Config } from '../config/config.types';
-import type { ModelConfig } from './ai.type';
-import { resolveModelAdapter } from './adapters/ai-adapters.usecases';
+import { resolveTextAdapter } from './adapters/ai-adapters.usecases';
import { chat as tanstackChat } from '@tanstack/ai';
import { toStandardJsonSchema } from '@valibot/to-json-schema';
import type { GenericSchema, InferOutput } from 'valibot';
@@ -13,7 +12,7 @@ export function createAiServices({ config }: { config: Config }) {
// wrapper preserves inference so callers get back InferOutput<Schema>.
return {
generateStructuredData: <Schema extends GenericSchema>(args: {
- model: ModelConfig;
+ modelId: string;
schema: Schema;
userPrompt: string;
systemPrompt?: string;
@@ -22,21 +21,21 @@ export function createAiServices({ config }: { config: Config }) {
}
async function generateStructuredData<Schema extends GenericSchema>({
- model,
+ modelId,
schema,
userPrompt,
systemPrompt,
config,
}: {
- model: ModelConfig;
+ modelId: string;
schema: Schema;
userPrompt: string;
systemPrompt?: string;
config: Config;
}): Promise<InferOutput<Schema>> {
- const { adapter } = resolveModelAdapter({
- model,
- adaptersConfig: config.ai.adapters,
+ const adapter = resolveTextAdapter({
+ modelId,
+ config,
});
const jsonSchema = toStandardJsonSchema(schema);
diff --git a/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.test.ts b/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.test.ts
index 7ea55c52..e1b11035 100644
--- a/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.test.ts
+++ b/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.test.ts
@@ -20,7 +20,7 @@ function createTestResolveOrganizationSettings(
isEnabled: true,
canCreateNewTags: false,
maxTags: 5,
- model: { adapterId: 'openai', modelName: 'gpt-4' },
+ modelId: 'gpt-4',
...autoTagging,
},
},
diff --git a/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.ts b/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.ts
index 8a2d3e82..ff649954 100644
--- a/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.ts
+++ b/apps/papra-server/src/modules/auto-tagging/auto-tagging.usecases.ts
@@ -1,7 +1,6 @@
import type { AiServices } from '../ai/ai.services';
import type { TagsRepository } from '../tags/tags.repository';
import type { ResolveOrganizationSettingsUsecase } from '../organizations/organization-settings/organization-settings.usecases';
-import { ensureModel } from '../ai/ai.models';
import type { DocumentsRepository } from '../documents/documents.repository';
import { createDocumentNotFoundError } from '../documents/documents.errors';
import type { Logger } from '@crowlog/logger';
@@ -74,7 +73,7 @@ export async function autoTagDocument({
const startedAt = Date.now();
const response = await aiServices.generateStructuredData({
- model: ensureModel(organizationSettings.ai.autoTagging.model),
+ modelId: organizationSettings.ai.autoTagging.modelId,
schema: buildAutoTaggingSchema({ existingTags, canCreateNewTags, maxTags }),
systemPrompt: buildAutoTaggingSystemPrompt({ existingTags, canCreateNewTags, maxTags }),
userPrompt: buildAutoTaggingUserPrompt({ document }),
diff --git a/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.types.ts b/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.types.ts
index 3d836653..d427cb46 100644
--- a/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.types.ts
+++ b/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.types.ts
@@ -1,4 +1,3 @@
-import type { ModelConfig } from '../../ai/ai.type';
import type { organizationSettingsTable } from './organization-settings.tables';
export type OrganizationSettings = {
@@ -7,7 +6,7 @@ export type OrganizationSettings = {
isEnabled: boolean;
canCreateNewTags: boolean;
maxTags: number;
- model?: ModelConfig;
+ modelId: string;
};
};
};
diff --git a/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.usecases.ts b/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.usecases.ts
index fa0b2391..7bb7e875 100644
--- a/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.usecases.ts
+++ b/apps/papra-server/src/modules/organizations/organization-settings/organization-settings.usecases.ts
@@ -1,4 +1,3 @@
-import { parseModelId, parseOptionalModelId } from '../../ai/ai.schemas.models';
import type { Config } from '../../config/config.types';
import type { OrganizationSettingsRepository } from './organization-settings.repository';
import type { OrganizationSettings } from './organization-settings.types';
@@ -55,10 +54,10 @@ export async function resolveOrganizationSettings({
maxTags:
organizationRawSettings?.aiAutoTaggingMaxTags ?? config.autoTagging.defaultMaxTags,
- model:
- parseOptionalModelId(organizationRawSettings?.aiAutoTaggingModelId) ??
- parseOptionalModelId(config.autoTagging.modelId) ??
- parseModelId(config.ai.defaultModelId),
+ modelId:
+ organizationRawSettings?.aiAutoTaggingModelId ??
+ config.autoTagging.modelId ??
+ config.ai.defaultModelId,
},
},
},
diff --git a/packages/std/src/index.ts b/packages/std/src/index.ts
index 7d02200d..63e90f90 100644
--- a/packages/std/src/index.ts
+++ b/packages/std/src/index.ts
@@ -1 +1,2 @@
export * from './string/string';
+export * from './object/object';
diff --git a/packages/std/src/object/object.ts b/packages/std/src/object/object.ts
new file mode 100644
index 00000000..97cdd8c6
--- /dev/null
+++ b/packages/std/src/object/object.ts
@@ -0,0 +1,3 @@
+export function objectKeys<T extends object>(obj: T): (keyof T)[] {
+ return Object.keys(obj) as (keyof T)[];
+}