RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
/*
* Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
IAddInstanceModelRequestBody,
IAddProviderInstanceRequestBody,
} from '@/interfaces/request/llm';
const MODEL_RESERVED_KEYS = new Set([
'llm_name',
'model_name',
'model_type',
'max_tokens',
]);
const INSTANCE_RESERVED_KEYS = new Set([
'instance_name',
'llm_factory',
'provider_name',
'base_url',
'region',
'verify',
'model_info',
]);
export const MODEL_EXTRA_KEYS = new Set([
'is_tools',
'vision',
'provider_order',
'api_version',
'somark_image_format',
'somark_formula_format',
'somark_table_format',
'somark_cs_format',
'somark_enable_text_cross_page',
'somark_enable_table_cross_page',
'somark_enable_title_level_recognition',
'somark_enable_inline_image',
'somark_enable_table_image',
'somark_enable_image_understanding',
'somark_keep_header_footer',
]);
export const MODEL_FIELD_NAMES = new Set<string>([
...MODEL_RESERVED_KEYS,
...MODEL_EXTRA_KEYS,
]);
export const isModelField = (fieldName: string) =>
MODEL_FIELD_NAMES.has(fieldName);
type FlatPayload = Record<string, any>;
export type SplitResult = {
instancePayload: Omit<
IAddProviderInstanceRequestBody,
'llm_name' | 'model_type' | 'max_tokens'
> & {
base_url?: string;
region?: string;
};
modelPayload: IAddInstanceModelRequestBody;
};
const collectApiKeyExtras = (payload: FlatPayload) => {
const extras: Record<string, any> = {};
let apiKeyValue: any = undefined;
for (const [key, value] of Object.entries(payload)) {
if (value === undefined) continue;
if (key === 'api_key') {
apiKeyValue = value;
continue;
}
if (INSTANCE_RESERVED_KEYS.has(key)) continue;
if (MODEL_RESERVED_KEYS.has(key)) continue;
if (MODEL_EXTRA_KEYS.has(key)) continue;
extras[key] = value;
}
if (apiKeyValue && typeof apiKeyValue === 'object') {
return { ...apiKeyValue, ...extras };
}
if (Object.keys(extras).length === 0) {
return apiKeyValue ?? '';
}
if (apiKeyValue !== undefined && apiKeyValue !== '') {
return { api_key: apiKeyValue, ...extras };
}
return extras;
};
const collectModelExtras = (payload: FlatPayload) => {
const extras: Record<string, any> = {};
for (const key of MODEL_EXTRA_KEYS) {
if (payload[key] !== undefined && payload[key] !== '') {
extras[key] = payload[key];
}
}
return extras;
};
export const splitProviderPayload = (payload: FlatPayload): SplitResult => {
const { instance_name, llm_factory, base_url, region, model_info, ...other } =
payload;
const instancePayload = {
instance_name: instance_name as string,
llm_factory: llm_factory as string,
api_key: collectApiKeyExtras(payload),
base_url: base_url as string | undefined,
region: (region as string | undefined) || 'default',
model_info: model_info,
...other,
};
const modelExtra = collectModelExtras(payload);
const modelPayload = {
model_name: (payload.model_name ?? payload.llm_name) as string,
model_type: payload.model_type,
max_tokens: payload.max_tokens as number,
...(Object.keys(modelExtra).length > 0 ? { extra: modelExtra } : {}),
};
return {
instancePayload: instancePayload as SplitResult['instancePayload'],
modelPayload,
};
};