Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor settings into a single component across Chat/Ask #2111

Merged
merged 5 commits into from
Nov 5, 2024
Merged

Refactor settings into a single component across Chat/Ask #2111

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e8087c
Refactor settings code across Chat/Ask
bnodir Nov 3, 2024
328f12a
Refactor settings code across Chat/Ask
bnodir Nov 3, 2024
94a5fed
Update docs for settings change
pamelafox Nov 5, 2024
d0a211f
Merge branch 'main' into refactor/shared-settings-component
pamelafox Nov 5, 2024
7968c4c
Update playwright test
pamelafox Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions app/frontend/src/components/Settings/Settings.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.settingsSeparator {
margin-top: 0.75rem;
}
316 changes: 316 additions & 0 deletions app/frontend/src/components/Settings/Settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
import { useId } from "@fluentui/react-hooks";
import { useTranslation } from "react-i18next";
import { TextField, ITextFieldProps, Checkbox, ICheckboxProps, Dropdown, IDropdownProps, IDropdownOption } from "@fluentui/react";
import { HelpCallout } from "../HelpCallout";
import { GPT4VSettings } from "../GPT4VSettings";
import { VectorSettings } from "../VectorSettings";
import { RetrievalMode, VectorFieldOptions, GPT4VInput } from "../../api";
import styles from "./Settings.module.css";

// Add type for onRenderLabel
type RenderLabelType = ITextFieldProps | IDropdownProps | ICheckboxProps;

export interface SettingsProps {
promptTemplate: string;
temperature: number;
retrieveCount: number;
seed: number | null;
minimumSearchScore: number;
minimumRerankerScore: number;
useSemanticRanker: boolean;
useSemanticCaptions: boolean;
excludeCategory: string;
includeCategory: string;
retrievalMode: RetrievalMode;
useGPT4V: boolean;
gpt4vInput: GPT4VInput;
vectorFieldList: VectorFieldOptions[];
showSemanticRankerOption: boolean;
showGPT4VOptions: boolean;
showVectorOption: boolean;
useOidSecurityFilter: boolean;
useGroupsSecurityFilter: boolean;
useLogin: boolean;
loggedIn: boolean;
requireAccessControl: boolean;
className?: string;
onChange: (field: string, value: any) => void;
shouldStream?: boolean; // Only used in Chat
useSuggestFollowupQuestions?: boolean; // Only used in Chat
promptTemplatePrefix?: string;
promptTemplateSuffix?: string;
showSuggestFollowupQuestions?: boolean;
}

export const Settings = ({
promptTemplate,
temperature,
retrieveCount,
seed,
minimumSearchScore,
minimumRerankerScore,
useSemanticRanker,
useSemanticCaptions,
excludeCategory,
includeCategory,
retrievalMode,
useGPT4V,
gpt4vInput,
vectorFieldList,
showSemanticRankerOption,
showGPT4VOptions,
showVectorOption,
useOidSecurityFilter,
useGroupsSecurityFilter,
useLogin,
loggedIn,
requireAccessControl,
className,
onChange,
shouldStream,
useSuggestFollowupQuestions,
promptTemplatePrefix,
promptTemplateSuffix,
showSuggestFollowupQuestions
}: SettingsProps) => {
const { t } = useTranslation();

// Form field IDs
const promptTemplateId = useId("promptTemplate");
const promptTemplateFieldId = useId("promptTemplateField");
const temperatureId = useId("temperature");
const temperatureFieldId = useId("temperatureField");
const seedId = useId("seed");
const seedFieldId = useId("seedField");
const searchScoreId = useId("searchScore");
const searchScoreFieldId = useId("searchScoreField");
const rerankerScoreId = useId("rerankerScore");
const rerankerScoreFieldId = useId("rerankerScoreField");
const retrieveCountId = useId("retrieveCount");
const retrieveCountFieldId = useId("retrieveCountField");
const includeCategoryId = useId("includeCategory");
const includeCategoryFieldId = useId("includeCategoryField");
const excludeCategoryId = useId("excludeCategory");
const excludeCategoryFieldId = useId("excludeCategoryField");
const semanticRankerId = useId("semanticRanker");
const semanticRankerFieldId = useId("semanticRankerField");
const semanticCaptionsId = useId("semanticCaptions");
const semanticCaptionsFieldId = useId("semanticCaptionsField");
const useOidSecurityFilterId = useId("useOidSecurityFilter");
const useOidSecurityFilterFieldId = useId("useOidSecurityFilterField");
const useGroupsSecurityFilterId = useId("useGroupsSecurityFilter");
const useGroupsSecurityFilterFieldId = useId("useGroupsSecurityFilterField");
const shouldStreamId = useId("shouldStream");
const shouldStreamFieldId = useId("shouldStreamField");
const suggestFollowupQuestionsId = useId("suggestFollowupQuestions");
const suggestFollowupQuestionsFieldId = useId("suggestFollowupQuestionsField");

const renderLabel = (props: RenderLabelType | undefined, labelId: string, fieldId: string, helpText: string) => (
<HelpCallout labelId={labelId} fieldId={fieldId} helpText={helpText} label={props?.label} />
);

return (
<div className={className}>
<TextField
id={promptTemplateFieldId}
className={styles.settingsSeparator}
defaultValue={promptTemplate}
label={t("labels.promptTemplate")}
multiline
autoAdjustHeight
onChange={(_ev, val) => onChange("promptTemplate", val || "")}
aria-labelledby={promptTemplateId}
onRenderLabel={props => renderLabel(props, promptTemplateId, promptTemplateFieldId, t("helpTexts.promptTemplate"))}
/>

<TextField
id={temperatureFieldId}
className={styles.settingsSeparator}
label={t("labels.temperature")}
type="number"
min={0}
max={1}
step={0.1}
defaultValue={temperature.toString()}
onChange={(_ev, val) => onChange("temperature", parseFloat(val || "0"))}
aria-labelledby={temperatureId}
onRenderLabel={props => renderLabel(props, temperatureId, temperatureFieldId, t("helpTexts.temperature"))}
/>

<TextField
id={seedFieldId}
className={styles.settingsSeparator}
label={t("labels.seed")}
type="text"
defaultValue={seed?.toString() || ""}
onChange={(_ev, val) => onChange("seed", val ? parseInt(val) : null)}
aria-labelledby={seedId}
onRenderLabel={props => renderLabel(props, seedId, seedFieldId, t("helpTexts.seed"))}
/>

<TextField
id={searchScoreFieldId}
className={styles.settingsSeparator}
label={t("labels.minimumSearchScore")}
type="number"
min={0}
step={0.01}
defaultValue={minimumSearchScore.toString()}
onChange={(_ev, val) => onChange("minimumSearchScore", parseFloat(val || "0"))}
aria-labelledby={searchScoreId}
onRenderLabel={props => renderLabel(props, searchScoreId, searchScoreFieldId, t("helpTexts.searchScore"))}
/>

{showSemanticRankerOption && (
<TextField
id={rerankerScoreFieldId}
className={styles.settingsSeparator}
label={t("labels.minimumRerankerScore")}
type="number"
min={1}
max={4}
step={0.1}
defaultValue={minimumRerankerScore.toString()}
onChange={(_ev, val) => onChange("minimumRerankerScore", parseFloat(val || "0"))}
aria-labelledby={rerankerScoreId}
onRenderLabel={props => renderLabel(props, rerankerScoreId, rerankerScoreFieldId, t("helpTexts.rerankerScore"))}
/>
)}

<TextField
id={retrieveCountFieldId}
className={styles.settingsSeparator}
label={t("labels.retrieveCount")}
type="number"
min={1}
max={50}
defaultValue={retrieveCount.toString()}
onChange={(_ev, val) => onChange("retrieveCount", parseInt(val || "3"))}
aria-labelledby={retrieveCountId}
onRenderLabel={props => renderLabel(props, retrieveCountId, retrieveCountFieldId, t("helpTexts.retrieveNumber"))}
/>

<Dropdown
id={includeCategoryFieldId}
className={styles.settingsSeparator}
label={t("labels.includeCategory")}
selectedKey={includeCategory}
onChange={(_ev?: React.FormEvent<HTMLElement | HTMLInputElement>, option?: IDropdownOption) => onChange("includeCategory", option?.key || "")}
aria-labelledby={includeCategoryId}
options={[
{ key: "", text: t("labels.includeCategoryOptions.all") }
// { key: "example", text: "Example Category" } // Add more categories as needed
]}
onRenderLabel={props => renderLabel(props, includeCategoryId, includeCategoryFieldId, t("helpTexts.includeCategory"))}
/>

<TextField
id={excludeCategoryFieldId}
className={styles.settingsSeparator}
label={t("labels.excludeCategory")}
defaultValue={excludeCategory}
onChange={(_ev, val) => onChange("excludeCategory", val || "")}
aria-labelledby={excludeCategoryId}
onRenderLabel={props => renderLabel(props, excludeCategoryId, excludeCategoryFieldId, t("helpTexts.excludeCategory"))}
/>

{showSemanticRankerOption && (
<>
<Checkbox
id={semanticRankerFieldId}
className={styles.settingsSeparator}
checked={useSemanticRanker}
label={t("labels.useSemanticRanker")}
onChange={(_ev, checked) => onChange("useSemanticRanker", !!checked)}
aria-labelledby={semanticRankerId}
onRenderLabel={props => renderLabel(props, semanticRankerId, semanticRankerFieldId, t("helpTexts.useSemanticReranker"))}
/>

<Checkbox
id={semanticCaptionsFieldId}
className={styles.settingsSeparator}
checked={useSemanticCaptions}
label={t("labels.useSemanticCaptions")}
onChange={(_ev, checked) => onChange("useSemanticCaptions", !!checked)}
disabled={!useSemanticRanker}
aria-labelledby={semanticCaptionsId}
onRenderLabel={props => renderLabel(props, semanticCaptionsId, semanticCaptionsFieldId, t("helpTexts.useSemanticCaptions"))}
/>
</>
)}

{useLogin && (
<>
<Checkbox
id={useOidSecurityFilterFieldId}
className={styles.settingsSeparator}
checked={useOidSecurityFilter || requireAccessControl}
label={t("labels.useOidSecurityFilter")}
disabled={!loggedIn || requireAccessControl}
onChange={(_ev, checked) => onChange("useOidSecurityFilter", !!checked)}
aria-labelledby={useOidSecurityFilterId}
onRenderLabel={props => renderLabel(props, useOidSecurityFilterId, useOidSecurityFilterFieldId, t("helpTexts.useOidSecurityFilter"))}
/>
<Checkbox
id={useGroupsSecurityFilterFieldId}
className={styles.settingsSeparator}
checked={useGroupsSecurityFilter || requireAccessControl}
label={t("labels.useGroupsSecurityFilter")}
disabled={!loggedIn || requireAccessControl}
onChange={(_ev, checked) => onChange("useGroupsSecurityFilter", !!checked)}
aria-labelledby={useGroupsSecurityFilterId}
onRenderLabel={props =>
renderLabel(props, useGroupsSecurityFilterId, useGroupsSecurityFilterFieldId, t("helpTexts.useGroupsSecurityFilter"))
}
/>
</>
)}

{showGPT4VOptions && (
<GPT4VSettings
gpt4vInputs={gpt4vInput}
isUseGPT4V={useGPT4V}
updateUseGPT4V={val => onChange("useGPT4V", val)}
updateGPT4VInputs={val => onChange("gpt4vInput", val)}
/>
)}

{showVectorOption && (
<VectorSettings
defaultRetrievalMode={retrievalMode}
showImageOptions={useGPT4V && showGPT4VOptions}
updateVectorFields={val => onChange("vectorFieldList", val)}
updateRetrievalMode={val => onChange("retrievalMode", val)}
/>
)}

{/* Streaming checkbox for Chat */}
{shouldStream !== undefined && (
<Checkbox
id={shouldStreamFieldId}
className={styles.settingsSeparator}
checked={shouldStream}
label={t("labels.shouldStream")}
onChange={(_ev, checked) => onChange("shouldStream", !!checked)}
aria-labelledby={shouldStreamId}
onRenderLabel={props => renderLabel(props, shouldStreamId, shouldStreamFieldId, t("helpTexts.streamChat"))}
/>
)}

{/* Followup questions checkbox for Chat */}
{showSuggestFollowupQuestions && (
<Checkbox
id={suggestFollowupQuestionsFieldId}
className={styles.settingsSeparator}
checked={useSuggestFollowupQuestions}
label={t("labels.useSuggestFollowupQuestions")}
onChange={(_ev, checked) => onChange("useSuggestFollowupQuestions", !!checked)}
aria-labelledby={suggestFollowupQuestionsId}
onRenderLabel={props =>
renderLabel(props, suggestFollowupQuestionsId, suggestFollowupQuestionsFieldId, t("helpTexts.suggestFollowupQuestions"))
}
/>
)}
</div>
);
};
Loading