Skip to content

Fix UI and answer gen issues #2541

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.

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

Merged
merged 12 commits into from
May 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion app/backend/approaches/approach.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ async def run_agentic_retrieval(
filter_add_on: Optional[str] = None,
minimum_reranker_score: Optional[float] = None,
max_docs_for_reranker: Optional[int] = None,
results_merge_strategy: Optional[str] = None,
) -> tuple[KnowledgeAgentRetrievalResponse, list[Document]]:
# STEP 1: Invoke agentic retrieval
response = await agent_client.retrieve(
Expand Down Expand Up @@ -298,7 +299,13 @@ async def run_agentic_retrieval(

results = []
if response and response.references:
for reference in response.references:
if results_merge_strategy == "interleaved":
# Use interleaved reference order
references = sorted(response.references, key=lambda reference: int(reference.id))
else:
# Default to descending strategy
references = response.references
for reference in references:
if isinstance(reference, KnowledgeAgentAzureSearchDocReference) and reference.source_data:
results.append(
Document(
Expand Down
3 changes: 3 additions & 0 deletions app/backend/approaches/chatreadretrieveread.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ async def run_agentic_retrieval_approach(
search_index_filter = self.build_filter(overrides, auth_claims)
top = overrides.get("top", 3)
max_subqueries = overrides.get("max_subqueries", 10)
results_merge_strategy = overrides.get("results_merge_strategy", "interleaved")
# 50 is the amount of documents that the reranker can process per query
max_docs_for_reranker = max_subqueries * 50

Expand All @@ -246,6 +247,7 @@ async def run_agentic_retrieval_approach(
filter_add_on=search_index_filter,
minimum_reranker_score=minimum_reranker_score,
max_docs_for_reranker=max_docs_for_reranker,
results_merge_strategy=results_merge_strategy,
)

text_sources = self.get_sources_content(results, use_semantic_captions=False, use_image_citation=False)
Expand All @@ -259,6 +261,7 @@ async def run_agentic_retrieval_approach(
{
"reranker_threshold": minimum_reranker_score,
"max_docs_for_reranker": max_docs_for_reranker,
"results_merge_strategy": results_merge_strategy,
"filter": search_index_filter,
},
),
Expand Down
3 changes: 3 additions & 0 deletions app/backend/approaches/retrievethenread.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ async def run_agentic_retrieval_approach(
search_index_filter = self.build_filter(overrides, auth_claims)
top = overrides.get("top", 3)
max_subqueries = overrides.get("max_subqueries", 10)
results_merge_strategy = overrides.get("results_merge_strategy", "interleaved")
# 50 is the amount of documents that the reranker can process per query
max_docs_for_reranker = max_subqueries * 50

Expand All @@ -197,6 +198,7 @@ async def run_agentic_retrieval_approach(
filter_add_on=search_index_filter,
minimum_reranker_score=minimum_reranker_score,
max_docs_for_reranker=max_docs_for_reranker,
results_merge_strategy=results_merge_strategy,
)

text_sources = self.get_sources_content(results, use_semantic_captions=False, use_image_citation=False)
Expand All @@ -210,6 +212,7 @@ async def run_agentic_retrieval_approach(
{
"reranker_threshold": minimum_reranker_score,
"max_docs_for_reranker": max_docs_for_reranker,
"results_merge_strategy": results_merge_strategy,
"filter": search_index_filter,
},
),
Expand Down
1 change: 1 addition & 0 deletions app/frontend/src/api/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export type ChatAppRequestOverrides = {
seed?: number;
top?: number;
max_subqueries?: number;
results_merge_strategy?: string;
temperature?: number;
minimum_search_score?: number;
minimum_reranker_score?: number;
Expand Down
25 changes: 23 additions & 2 deletions app/frontend/src/components/Settings/Settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export interface SettingsProps {
temperature: number;
retrieveCount: number;
maxSubqueryCount: number;
resultsMergeStrategy: string;
seed: number | null;
minimumSearchScore: number;
minimumRerankerScore: number;
Expand Down Expand Up @@ -55,6 +56,7 @@ export const Settings = ({
temperature,
retrieveCount,
maxSubqueryCount,
resultsMergeStrategy,
seed,
minimumSearchScore,
minimumRerankerScore,
Expand Down Expand Up @@ -108,6 +110,7 @@ export const Settings = ({
const retrieveCountFieldId = useId("retrieveCountField");
const maxSubqueryCountId = useId("maxSubqueryCount");
const maxSubqueryCountFieldId = useId("maxSubqueryCountField");
const resultsMergeStrategyFieldId = useId("resultsMergeStrategy");
const includeCategoryId = useId("includeCategory");
const includeCategoryFieldId = useId("includeCategoryField");
const excludeCategoryId = useId("excludeCategory");
Expand Down Expand Up @@ -218,15 +221,33 @@ export const Settings = ({
className={styles.settingsSeparator}
label={t("labels.maxSubqueryCount")}
type="number"
min={1}
max={20}
min={2}
max={40}
defaultValue={maxSubqueryCount.toString()}
onChange={(_ev, val) => onChange("maxSubqueryCount", parseInt(val || "10"))}
aria-labelledby={maxSubqueryCountId}
onRenderLabel={props => renderLabel(props, maxSubqueryCountId, maxSubqueryCountFieldId, t("helpTexts.maxSubqueryCount"))}
/>
)}

{showAgenticRetrievalOption && useAgenticRetrieval && (
<Dropdown
id={resultsMergeStrategyFieldId}
className={styles.settingsSeparator}
label={t("labels.resultsMergeStrategy")}
selectedKey={resultsMergeStrategy}
onChange={(_ev?: React.FormEvent<HTMLElement | HTMLInputElement>, option?: IDropdownOption) =>
onChange("resultsMergeStrategy", option?.key)
}
aria-labelledby={includeCategoryId}
options={[
{ key: "interleaved", text: t("labels.resultsMergeStrategyOptions.interleaved") },
{ key: "descending", text: t("labels.resultsMergeStrategyOptions.descending") }
]}
onRenderLabel={props => renderLabel(props, includeCategoryId, includeCategoryFieldId, t("helpTexts.resultsMergeStrategy"))}
/>
)}

<TextField
id={retrieveCountFieldId}
className={styles.settingsSeparator}
Expand Down
7 changes: 7 additions & 0 deletions app/frontend/src/locales/en/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@
"minimumRerankerScore": "Minimum reranker score",
"retrieveCount": "Retrieve this many search results:",
"maxSubqueryCount": "Max subqueries",
"resultsMergeStrategy": "Results merge strategy",
"resultsMergeStrategyOptions": {
"interleaved": "Interleaved",
"descending": "Descending"
},
"includeCategory": "Include category",
"includeCategoryOptions": {
"all": "All"
Expand Down Expand Up @@ -144,6 +149,8 @@
"Sets the number of search results to retrieve from Azure AI search. More results may increase the likelihood of finding the correct answer, but may lead to the model getting 'lost in the middle'.",
"maxSubqueryCount":
"Sets the maximum number of subqueries to use for the agentic retrieval query plan.",
"resultsMergeStrategy":
"Sets the strategy for merging results from multiple subqueries. Interleaved picks the top results from each subquery in round robin order, while descending sorts all results by reranker score.",
"includeCategory":
"Specifies a category to include in the search results. There are no categories used in the default data set.",
"excludeCategory":
Expand Down
9 changes: 9 additions & 0 deletions app/frontend/src/pages/ask/Ask.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export function Component(): JSX.Element {
const [retrievalMode, setRetrievalMode] = useState<RetrievalMode>(RetrievalMode.Hybrid);
const [retrieveCount, setRetrieveCount] = useState<number>(3);
const [maxSubqueryCount, setMaxSubqueryCount] = useState<number>(10);
const [resultsMergeStrategy, setResultsMergeStrategy] = useState<string>("interleaved");
const [useSemanticRanker, setUseSemanticRanker] = useState<boolean>(true);
const [useSemanticCaptions, setUseSemanticCaptions] = useState<boolean>(false);
const [useQueryRewriting, setUseQueryRewriting] = useState<boolean>(false);
Expand Down Expand Up @@ -102,6 +103,9 @@ export function Component(): JSX.Element {
setShowSpeechOutputAzure(config.showSpeechOutputAzure);
setShowAgenticRetrievalOption(config.showAgenticRetrievalOption);
setUseAgenticRetrieval(config.showAgenticRetrievalOption);
if (config.showAgenticRetrievalOption) {
setRetrieveCount(10);
}
});
};

Expand Down Expand Up @@ -136,6 +140,7 @@ export function Component(): JSX.Element {
exclude_category: excludeCategory.length === 0 ? undefined : excludeCategory,
top: retrieveCount,
max_subqueries: maxSubqueryCount,
results_merge_strategy: resultsMergeStrategy,
temperature: temperature,
minimum_reranker_score: minimumRerankerScore,
minimum_search_score: minimumSearchScore,
Expand Down Expand Up @@ -196,6 +201,9 @@ export function Component(): JSX.Element {
case "maxSubqueryCount":
setMaxSubqueryCount(value);
break;
case "resultsMergeStrategy":
setResultsMergeStrategy(value);
break;
case "useSemanticRanker":
setUseSemanticRanker(value);
break;
Expand Down Expand Up @@ -347,6 +355,7 @@ export function Component(): JSX.Element {
temperature={temperature}
retrieveCount={retrieveCount}
maxSubqueryCount={maxSubqueryCount}
resultsMergeStrategy={resultsMergeStrategy}
seed={seed}
minimumSearchScore={minimumSearchScore}
minimumRerankerScore={minimumRerankerScore}
Expand Down
10 changes: 10 additions & 0 deletions app/frontend/src/pages/chat/Chat.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ const Chat = () => {
const [minimumSearchScore, setMinimumSearchScore] = useState<number>(0);
const [retrieveCount, setRetrieveCount] = useState<number>(3);
const [maxSubqueryCount, setMaxSubqueryCount] = useState<number>(10);
const [resultsMergeStrategy, setResultsMergeStrategy] = useState<string>("interleaved");
const [retrievalMode, setRetrievalMode] = useState<RetrievalMode>(RetrievalMode.Hybrid);
const [useSemanticRanker, setUseSemanticRanker] = useState<boolean>(true);
const [useQueryRewriting, setUseQueryRewriting] = useState<boolean>(false);
Expand Down Expand Up @@ -135,6 +136,9 @@ const Chat = () => {
setShowChatHistoryCosmos(config.showChatHistoryCosmos);
setShowAgenticRetrievalOption(config.showAgenticRetrievalOption);
setUseAgenticRetrieval(config.showAgenticRetrievalOption);
if (config.showAgenticRetrievalOption) {
setRetrieveCount(10);
}
});
};

Expand Down Expand Up @@ -215,6 +219,8 @@ const Chat = () => {
include_category: includeCategory.length === 0 ? undefined : includeCategory,
exclude_category: excludeCategory.length === 0 ? undefined : excludeCategory,
top: retrieveCount,
max_subqueries: maxSubqueryCount,
results_merge_strategy: resultsMergeStrategy,
temperature: temperature,
minimum_reranker_score: minimumRerankerScore,
minimum_search_score: minimumSearchScore,
Expand Down Expand Up @@ -312,6 +318,9 @@ const Chat = () => {
case "maxSubqueryCount":
setMaxSubqueryCount(value);
break;
case "resultsMergeStrategy":
setResultsMergeStrategy(value);
break;
case "useSemanticRanker":
setUseSemanticRanker(value);
break;
Expand Down Expand Up @@ -534,6 +543,7 @@ const Chat = () => {
temperature={temperature}
retrieveCount={retrieveCount}
maxSubqueryCount={maxSubqueryCount}
resultsMergeStrategy={resultsMergeStrategy}
seed={seed}
minimumSearchScore={minimumSearchScore}
minimumRerankerScore={minimumRerankerScore}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"props": {
"filter": null,
"max_docs_for_reranker": 500,
"reranker_threshold": 0
"reranker_threshold": 0,
"results_merge_strategy": "interleaved"
},
"title": "Use agentic retrieval"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"props": {
"filter": "category ne 'excluded' and (oids/any(g:search.in(g, 'OID_X')) or groups/any(g:search.in(g, 'GROUP_Y, GROUP_Z')))",
"max_docs_for_reranker": 500,
"reranker_threshold": 0
"reranker_threshold": 0,
"results_merge_strategy": "interleaved"
},
"title": "Use agentic retrieval"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"props": {
"filter": null,
"max_docs_for_reranker": 500,
"reranker_threshold": 0
"reranker_threshold": 0,
"results_merge_strategy": "interleaved"
},
"title": "Use agentic retrieval"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"props": {
"filter": "category ne 'excluded' and (oids/any(g:search.in(g, 'OID_X')) or groups/any(g:search.in(g, 'GROUP_Y, GROUP_Z')))",
"max_docs_for_reranker": 500,
"reranker_threshold": 0
"reranker_threshold": 0,
"results_merge_strategy": "interleaved"
},
"title": "Use agentic retrieval"
},
Expand Down