Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

12.4 KB
Raw Blame
import React, { useMemo, useEffect } from 'react';
import { ChevronLeft, RotateCcw } from 'lucide-react';
import { Alert, Button, ControlCombobox } from '@librechat/client';
import { useFormContext, useWatch, Controller } from 'react-hook-form';
import {
  Permissions,
  alternateName,
  PermissionTypes,
  LocalStorageKeys,
  resolveModelCatalogKey,
} from 'librechat-data-provider';
import type * as t from 'librechat-data-provider';
import type { AgentForm, AgentModelPanelProps, StringOption } from '~/common';
import { pruneAgentModelParameters, resolveAgentParameterSettings } from './parameters';
import { groupParameters, hasControl } from '~/components/SidePanel/Parameters/groups';
import { componentMapping } from '~/components/SidePanel/Parameters/components';
import { useGetEndpointsQuery, useGetStartupConfig } from '~/data-provider';
import { useModelReasoning } from '~/hooks/Endpoint/useModelReasoning';
import Sections from '~/components/SidePanel/Parameters/Sections';
import { useLocalize, useHasAccess } from '~/hooks';
import { useLiveAnnouncer } from '~/Providers';
import { Panel } from '~/common';
import { cn } from '~/utils';

function getModelPlaceholderKey(modelsPending: boolean, provider: string) {
  if (modelsPending) {
    return 'com_ui_loading';
  }
  if (provider) {
    return 'com_ui_select_model';
  }
  return 'com_ui_select_provider_first';
}

export default function ModelPanel({
  providers,
  modelsError,
  setActivePanel,
  models: modelsData,
  modelsReady,
}: Pick<
  AgentModelPanelProps,
  'models' | 'modelsError' | 'modelsReady' | 'providers' | 'setActivePanel'
>) {
  const localize = useLocalize();
  const { announcePolite } = useLiveAnnouncer();

  const { control, setValue, getValues } = useFormContext<AgentForm>();

  const model = useWatch({ control, name: 'model' });
  const providerOption = useWatch({ control, name: 'provider' });
  const modelParameters = useWatch({ control, name: 'model_parameters' });

  const provider = useMemo(() => {
    const value =
      typeof providerOption === 'string'
        ? providerOption
        : (providerOption as StringOption | undefined)?.value;
    return value ?? '';
  }, [providerOption]);
  const models = useMemo(
    () => (provider ? (modelsData[resolveModelCatalogKey(provider, modelsData)] ?? []) : []),
    [modelsData, provider],
  );
  const modelsPending = !modelsReady && !modelsError;
  const selectionDisabled = !modelsReady || modelsError;

  const { data: endpointsConfig = {} } = useGetEndpointsQuery();
  const { data: startupConfig } = useGetStartupConfig();
  const { modelReasoning } = useModelReasoning(endpointsConfig, provider, model ?? '');

  const bedrockRegions = useMemo(() => {
    return endpointsConfig?.[provider]?.availableRegions ?? [];
  }, [endpointsConfig, provider]);

  const webSearchAllowed = useHasAccess({
    permissionType: PermissionTypes.WEB_SEARCH,
    permission: Permissions.USE,
  });

  const parameterSettings = useMemo(
    () =>
      resolveAgentParameterSettings({
        endpointsConfig,
        model: model ?? '',
        provider,
        startupConfig,
        webSearchAllowed,
        modelReasoning,
      }),
    [endpointsConfig, model, modelReasoning, provider, startupConfig, webSearchAllowed],
  );
  /** The rendered set omits role-gated controls; `parameterSettings.parameters`
   *  stays complete so the pruning effect below still recognises them. */
  const { visibleParameters: parameters } = parameterSettings;
  const webSearchBlocked =
    !webSearchAllowed &&
    (modelParameters?.web_search === true ||
      parameterSettings.parameters.some((parameter) => parameter.key === 'web_search'));

  /**
   * Prunes `model_parameters` entries that no longer have a visible control (e.g. a
   * parameter newly added to the endpoint's `dropParams`), mirroring the conversation
   * panel's pruning effect. Otherwise the stale value stays saved and silently reactivates
   * if the endpoint config later stops dropping it, with no control to inspect or clear it.
   */
  useEffect(() => {
    const currentParameters = getValues('model_parameters') ?? ({} as t.AgentModelParameters);
    const prunedParameters = pruneAgentModelParameters(currentParameters, parameterSettings);
    if (prunedParameters === currentParameters) {
      return;
    }

    setValue('model_parameters', prunedParameters);
  }, [parameterSettings, getValues, setValue]);

  /** Same grouping as the chat panel: region choices are filled in first, and a
   *  control with nothing to render is dropped so no section stands empty. */
  const sections = useMemo(
    () =>
      groupParameters(
        (parameters ?? [])
          .map((setting) =>
            setting.key === 'region' && bedrockRegions.length > 0
              ? { ...setting, options: bedrockRegions }
              : setting,
          )
          .filter((setting) => componentMapping[setting.component] != null && hasControl(setting)),
      ),
    [parameters, bedrockRegions],
  );

  const setOption = (optionKey: keyof t.AgentModelParameters) => (value: t.AgentParameterValue) => {
    setValue(`model_parameters.${optionKey}`, value);
  };

  const handleResetParameters = () => {
    setValue('model_parameters', {} as t.AgentModelParameters);
    announcePolite({ message: localize('com_ui_model_parameters_reset'), isStatus: true });
  };

  return (
    <div className="mb-1 flex w-full flex-col gap-3 text-sm">
      <header className="grid grid-cols-[auto_1fr_auto] items-center gap-2 pt-1">
        <Button
          variant="outline"
          size="icon"
          onClick={() => setActivePanel(Panel.builder)}
          aria-label={localize('com_ui_back_to_builder')}
          className="text-text-secondary hover:bg-surface-secondary shrink-0 rounded-xl"
        >
          <ChevronLeft className="h-5 w-5 rtl:-scale-x-100" strokeWidth={1.75} aria-hidden="true" />
        </Button>
        <h2 className="text-text-primary text-center text-base font-semibold">
          {localize('com_ui_model_parameters')}
        </h2>
        <span
          aria-hidden="true"
          className="size-theme-button min-h-theme-target min-w-theme-target"
        />
      </header>
      <div>
        {/* Endpoint aka Provider for Agents */}
        <div className="mb-3" aria-busy={modelsPending}>
          <label
            id="provider-label"
            className={cn(
              'text-text-secondary text-2xs mb-1 block font-medium tracking-wide uppercase',
              modelsPending && 'opacity-60',
            )}
            htmlFor="provider"
          >
            {localize('com_ui_provider')} <span className="text-text-destructive">*</span>
          </label>
          <Controller
            name="provider"
            control={control}
            rules={{ required: true, minLength: 1 }}
            render={({ field, fieldState: { error } }) => {
              const value =
                typeof field.value === 'string'
                  ? field.value
                  : ((field.value as StringOption)?.value ?? '');
              const display =
                typeof field.value === 'string'
                  ? field.value
                  : ((field.value as StringOption)?.label ?? '');

              return (
                <>
                  <ControlCombobox
                    selectId="provider"
                    selectedValue={value}
                    displayValue={alternateName[display] ?? display}
                    selectPlaceholder={localize('com_ui_select_provider')}
                    searchPlaceholder={localize('com_ui_select_search_provider')}
                    setValue={(value) => {
                      if (value === provider) {
                        return;
                      }
                      const nextModel =
                        modelsData[resolveModelCatalogKey(value, modelsData)]?.[0] ?? '';
                      field.onChange(value);
                      setValue('model', nextModel);
                      localStorage.setItem(LocalStorageKeys.LAST_AGENT_PROVIDER, value);
                      if (nextModel) {
                        localStorage.setItem(LocalStorageKeys.LAST_AGENT_MODEL, nextModel);
                      } else {
                        localStorage.removeItem(LocalStorageKeys.LAST_AGENT_MODEL);
                      }
                    }}
                    items={providers.map((provider) => ({
                      label: typeof provider === 'string' ? provider : provider.label,
                      value: typeof provider === 'string' ? provider : provider.value,
                    }))}
                    className={cn(error ? 'border-border-destructive border-2' : '')}
                    ariaLabel={localize('com_ui_provider')}
                    disabled={selectionDisabled}
                    isCollapsed={false}
                    showCarat={true}
                  />
                  {error && (
                    <span className="text-text-destructive mt-1 text-xs" role="alert">
                      {localize('com_ui_field_required')}
                    </span>
                  )}
                </>
              );
            }}
          />
        </div>
        {/* Model */}
        <div className="mb-3" aria-busy={modelsPending}>
          <label
            id="model-label"
            className={cn(
              'text-text-secondary text-2xs mb-1 block font-medium tracking-wide uppercase',
              (!provider || modelsPending) && 'opacity-60',
            )}
            htmlFor="model"
          >
            {localize('com_ui_model')} <span className="text-text-destructive">*</span>
          </label>
          <Controller
            name="model"
            control={control}
            rules={{ required: true, minLength: 1 }}
            render={({ field, fieldState: { error } }) => {
              return (
                <>
                  <ControlCombobox
                    selectId="model"
                    selectedValue={field.value || ''}
                    selectPlaceholder={localize(getModelPlaceholderKey(modelsPending, provider))}
                    searchPlaceholder={localize('com_ui_select_model')}
                    setValue={(value) => {
                      field.onChange(value);
                      localStorage.setItem(LocalStorageKeys.LAST_AGENT_PROVIDER, provider);
                      if (value) {
                        localStorage.setItem(LocalStorageKeys.LAST_AGENT_MODEL, value);
                      } else {
                        localStorage.removeItem(LocalStorageKeys.LAST_AGENT_MODEL);
                      }
                    }}
                    items={models.map((model) => ({
                      label: model,
                      value: model,
                    }))}
                    disabled={!provider || selectionDisabled}
                    className={cn(
                      'disabled:opacity-50',
                      error ? 'border-border-destructive border-2' : '',
                    )}
                    ariaLabel={localize('com_ui_model')}
                    isCollapsed={false}
                    showCarat={true}
                  />
                  {provider && error && (
                    <span className="text-text-destructive mt-1 text-xs" role="alert">
                      {localize('com_ui_field_required')}
                    </span>
                  )}
                </>
              );
            }}
          />
          {modelsError && (
            <Alert variant="error" className="mt-1">
              {localize('com_error_models_not_loaded')}
            </Alert>
          )}
        </div>
      </div>
      {webSearchBlocked && (
        <Alert variant="warning" role="status">
          {localize('com_ui_native_web_search_denied')}
        </Alert>
      )}
      {/* Model Parameters */}
      {sections.length > 0 && (
        <div className="h-auto max-w-full">
          <Sections
            sections={sections}
            setOption={setOption as t.TSetOption}
            conversation={modelParameters as Partial<t.TConversation>}
          />
        </div>
      )}
      {/* Reset Parameters Button */}
      <Button
        variant="outline"
        onClick={handleResetParameters}
        className="text-text-secondary hover:bg-surface-secondary mt-2 h-9 w-full rounded-xl font-medium"
      >
        <RotateCcw className="h-4 w-4" strokeWidth={1.75} aria-hidden="true" />
        {localize('com_ui_reset_var', { 0: localize('com_ui_model_parameters') })}
      </Button>
    </div>
  );
}