Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

9.4 KB
Raw Blame
/*
 *  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 {
  ModelVariableType,
  settledModelVariableMap,
} from '@/constants/knowledge';
import { useTranslate } from '@/hooks/common-hooks';
import { camelCase, isEqual } from 'lodash';
import { useCallback } from 'react';
import { useFormContext } from 'react-hook-form';
import { z } from 'zod';
import { Collapse } from '../collapse';
import {
  FormControl,
  FormField,
  FormItem,
  FormLabel,
  FormMessage,
} from '../ui/form';
import {
  Select,
  SelectContent,
  SelectItem,
  SelectTrigger,
  SelectValue,
} from '../ui/select';
import { LLMFormField } from './llm-form-field';
import { SliderInputSwitchFormField } from './slider';
import { useHandleFreedomChange } from './use-watch-change';

interface LlmSettingFieldItemsProps {
  prefix?: string;
  modelTypes?: string[];
  llmId?: string;
  llmSelectTestId?: string;
  llmOptionTestIdPrefix?: string;
  showFields?: Array<
    | 'temperature'
    | 'top_p'
    | 'presence_penalty'
    | 'frequency_penalty'
    | 'max_tokens'
    | 'thinking'
  >;
  showCollapse?: boolean;
  collapseOpen?: boolean;
  onCollapseOpenChange?: (open: boolean) => void;
  ownerTenantId?: string;
  llmRequired?: boolean;
}

export const LLMIdFormField = {
  llm_id: z.string(),
};

export const LlmSettingEnabledSchema = {
  temperatureEnabled: z.boolean().optional(),
  topPEnabled: z.boolean().optional(),
  presencePenaltyEnabled: z.boolean().optional(),
  frequencyPenaltyEnabled: z.boolean().optional(),
  maxTokensEnabled: z.boolean().optional(),
};

export const LlmSettingFieldSchema = {
  temperature: z.coerce.number().optional(),
  top_p: z.number().optional(),
  presence_penalty: z.coerce.number().optional(),
  frequency_penalty: z.coerce.number().optional(),
  max_tokens: z.number().optional(),
  parameter: z.string().optional(),
  thinking: z.enum(['default', 'enabled', 'disabled']).optional(),
};

export const LlmSettingSchema = {
  ...LLMIdFormField,
  ...LlmSettingFieldSchema,
  ...LlmSettingEnabledSchema,
};

export function LlmSettingFieldItems({
  prefix,
  modelTypes,
  llmSelectTestId,
  llmOptionTestIdPrefix,
  showFields = [
    'temperature',
    'top_p',
    'presence_penalty',
    'frequency_penalty',
    'max_tokens',
    'thinking',
  ],
  llmId,
  showCollapse = false,
  collapseOpen,
  onCollapseOpenChange,
  ownerTenantId,
  llmRequired = false,
}: LlmSettingFieldItemsProps) {
  const form = useFormContext();
  const { t } = useTranslate('chat');

  const getFieldWithPrefix = useCallback(
    (name: string) => {
      return prefix ? `${prefix}.${name}` : name;
    },
    [prefix],
  );

  const handleChange = useHandleFreedomChange(getFieldWithPrefix);

  const parameterOptions = Object.values(ModelVariableType).map((x) => ({
    label: t(camelCase(x)),
    value: x,
  })) as { label: string; value: ModelVariableType | 'Custom' }[];

  parameterOptions.push({
    label: t(camelCase('Custom')),
    value: 'Custom',
  });
  const checkParameterIsEqual = () => {
    const [
      parameter,
      topPValue,
      frequencyPenaltyValue,
      temperatureValue,
      presencePenaltyValue,
      maxTokensValue,
    ] = form.getValues([
      getFieldWithPrefix('parameter'),
      getFieldWithPrefix('temperature'),
      getFieldWithPrefix('top_p'),
      getFieldWithPrefix('frequency_penalty'),
      getFieldWithPrefix('presence_penalty'),
      getFieldWithPrefix('max_tokens'),
    ]);
    if (parameter && parameter !== 'Custom') {
      const parameterValue =
        settledModelVariableMap[parameter as keyof typeof ModelVariableType];
      const parameterRealValue = {
        top_p: topPValue,
        temperature: temperatureValue,
        frequency_penalty: frequencyPenaltyValue,
        presence_penalty: presencePenaltyValue,
        max_tokens: maxTokensValue,
      };
      if (!isEqual(parameterValue, parameterRealValue)) {
        form.setValue(getFieldWithPrefix('parameter'), 'Custom');
      }
    }
  };

  const settingFields = (
    <section className="space-y-5">
      <FormField
        control={form.control}
        name={getFieldWithPrefix('parameter')}
        render={({ field }) => (
          <FormItem className="flex justify-between items-center">
            <FormLabel className="flex-1">{t('freedom')}</FormLabel>
            <FormControl>
              <Select
                value={field.value}
                onValueChange={(val) => {
                  handleChange(val);
                  field.onChange(val);
                }}
              >
                <SelectTrigger className="flex-1 !m-0">
                  <SelectValue />
                </SelectTrigger>
                <SelectContent>
                  {parameterOptions.map((x) => (
                    <SelectItem value={x.value} key={x.value}>
                      {x.label}
                    </SelectItem>
                  ))}
                </SelectContent>
              </Select>
            </FormControl>
            <FormMessage />
          </FormItem>
        )}
      />
      {showFields.some((item) => item === 'temperature') && (
        <SliderInputSwitchFormField
          name={getFieldWithPrefix('temperature')}
          checkName="temperatureEnabled"
          label="temperature"
          max={1}
          step={0.01}
          min={0}
          onChange={() => {
            checkParameterIsEqual();
          }}
        ></SliderInputSwitchFormField>
      )}
      {showFields.some((item) => item === 'top_p') && (
        <SliderInputSwitchFormField
          name={getFieldWithPrefix('top_p')}
          checkName="topPEnabled"
          label="topP"
          max={1}
          step={0.01}
          min={0}
          onChange={() => {
            checkParameterIsEqual();
          }}
        ></SliderInputSwitchFormField>
      )}
      {showFields.some((item) => item === 'presence_penalty') && (
        <SliderInputSwitchFormField
          name={getFieldWithPrefix('presence_penalty')}
          checkName="presencePenaltyEnabled"
          label="presencePenalty"
          max={1}
          step={0.01}
          min={0}
          onChange={() => {
            checkParameterIsEqual();
          }}
        ></SliderInputSwitchFormField>
      )}
      {showFields.some((item) => item === 'frequency_penalty') && (
        <SliderInputSwitchFormField
          name={getFieldWithPrefix('frequency_penalty')}
          checkName="frequencyPenaltyEnabled"
          label="frequencyPenalty"
          max={1}
          step={0.01}
          min={0}
          onChange={() => {
            checkParameterIsEqual();
          }}
        ></SliderInputSwitchFormField>
      )}
      {showFields.some((item) => item === 'max_tokens') && (
        <SliderInputSwitchFormField
          name={getFieldWithPrefix('max_tokens')}
          checkName="maxTokensEnabled"
          numberInputClassName="w-24 shrink-0"
          label="maxTokens"
          max={128000}
          min={0}
          onChange={() => {
            checkParameterIsEqual();
          }}
        ></SliderInputSwitchFormField>
      )}
      {showFields.some((item) => item === 'thinking') && (
        <FormField
          control={form.control}
          name={getFieldWithPrefix('thinking')}
          render={({ field }) => (
            <FormItem className="flex justify-between items-center">
              <FormLabel className="flex-1" tooltip={t('thinkingTip')}>
                {t('thinkingMode')}
              </FormLabel>
              <FormControl>
                <Select
                  value={field.value ?? 'default'}
                  onValueChange={field.onChange}
                >
                  <SelectTrigger className="flex-1 !m-0">
                    <SelectValue />
                  </SelectTrigger>
                  <SelectContent>
                    <SelectItem value="default">
                      {t('thinkingDefault')}
                    </SelectItem>
                    <SelectItem value="enabled">
                      {t('thinkingEnabled')}
                    </SelectItem>
                    <SelectItem value="disabled">
                      {t('thinkingDisabled')}
                    </SelectItem>
                  </SelectContent>
                </Select>
              </FormControl>
              <FormMessage />
            </FormItem>
          )}
        />
      )}
    </section>
  );

  return (
    <div className="space-y-5">
      <LLMFormField
        modelTypes={modelTypes}
        name={llmId ?? getFieldWithPrefix('llm_id')}
        testId={llmSelectTestId}
        optionTestIdPrefix={llmOptionTestIdPrefix}
        ownerTenantId={ownerTenantId}
        required={llmRequired}
      ></LLMFormField>
      {showCollapse ? (
        <Collapse
          title={t('modelSetting')}
          open={collapseOpen}
          onOpenChange={onCollapseOpenChange}
        >
          {settingFields}
        </Collapse>
      ) : (
        settingFields
      )}
    </div>
  );
}