[Search][Playground] Support Multiple Context Fields #210703

TattdCodeMonkey · 2025-02-11T21:56:16Z

Summary

This PR updates the search playground to allow selecting > 1 context fields to be included in context documents for the LLM.

Screenshots

Context Fields Updated to ComboBox:

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed

dmlemeshko

x-pack/test/functional/config.base.js changes LGTM

Samiul-TheSoccerFan

LGTM, left some comments. It might be worth having @yansavitski take a look as well.

Samiul-TheSoccerFan · 2025-02-12T14:09:46Z

...ns/search/plugins/search_playground/public/components/edit_context/context_fields_select.tsx

+    };
+  }, [indexFields.source_fields, selectedContextFields]);
+  const onSelectFields = useCallback(
+    (updatedSelectedOptions: Array<EuiComboBoxOptionOption<unknown>>) => {


shouldn't we avoid defining unknown and any as a type?

we should avoid any, uknown is perfectly fine.

Using unknown TS will make you do type checks to validate what the type is. But in this case thats the option data type and what we need to access is for the EuiComboBoxOptionOption. So the option type is not needed in this callback currently.

Samiul-TheSoccerFan · 2025-02-12T14:13:25Z

...tions/search/plugins/search_playground/public/components/edit_context/edit_context_panel.tsx

-                      size="s"
-                    />
-                  )}
+                  <ContextFieldsSelect


Samiul-TheSoccerFan · 2025-02-12T14:17:38Z

x-pack/solutions/search/plugins/search_playground/server/lib/conversational_chain.test.ts

@@ -38,7 +38,7 @@ describe('conversational chain', () => {
    expectedTokens?: any;
    expectedErrorMessage?: string;
    expectedSearchRequest?: any;
-    contentField?: Record<string, string>;
+    contentField?: Record<string, string | string[]>;


may be replace this with ElasticsearchRetrieverContentField?

ElasticsearchRetrieverContentField is string | Record<string, string | string[]> which would then require this filed to handle contentField being a string. Which it never is. So it would just unnecessarily complicate this code IMO.

TattdCodeMonkey · 2025-02-12T15:07:19Z

@Samiul-TheSoccerFan FYI this PR is 90% there but I still have to update the UI to select all the context fields by default. Which is what I'll be working on today.

joemcelroy · 2025-02-13T19:54:42Z

x-pack/solutions/search/plugins/search_playground/server/utils/context_document_mapper.ts

+  (hit: SearchHit): Document => {
+    let pageContent: string = '';
+    const makePageContentForField = (field: string) =>
+      `${field}: ${getValueForSelectedField(hit, field)}`;


update this function to check if contentField has a field value

joemcelroy · 2025-02-13T20:30:55Z

works well! tested with a few scenarios. The only thing left is updating the view code example to include multiple context fields.

yansavitski

LGTM

TattdCodeMonkey · 2025-02-14T20:00:55Z

@joemcelroy can we update the python code to support multiple context fields? looking at the python code it looks like it only support str or Mapping[str, str] and not Mapping[str, str[]] which is what we would need right?

Or does that just mean we need to show a custom document mapper if there is multiple context fields?

I did update the vanilla python example to support multiple context fields, but I haven't had a chance to test that code yet. So i'll need to do that before we merge these changes.

joemcelroy · 2025-02-18T14:37:54Z

@joemcelroy can we update the python code to support multiple context fields? looking at the python code it looks like it only support str or Mapping[str, str] and not Mapping[str, str[]] which is what we would need right?

Or does that just mean we need to show a custom document mapper if there is multiple context fields?

Yes, for LangChain code lets have a custom document mapper if theres multiple context fields. We can consider in future to update the LangChain retriever to support multiple context fields.

…thout casting

…en handling chat messages

…om the context documents

…le context fields

TattdCodeMonkey · 2025-02-20T19:46:09Z

@joemcelroy this is updated to use a custom document mapper for langchain retriever if you have >1 context field selected. I tested both scenarios locally and everything should be good and functional.

I did update the question in the lang chain example to be more generic and try and encourage its replacement based on actually user data "What is it you want to ask the LLM?"

If you have time give it another 👀

joemcelroy

This is great! Thank you.

TattdCodeMonkey · 2025-02-21T16:46:14Z

@elasticmachine merge upstream

elasticmachine · 2025-02-21T18:39:29Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 6f5b1ac

Failed CI Steps

FTR Configs #46

Test Failures

[job] [logs] FTR Configs #46 / visualize app annotation listing page search "after each" hook for "filters by tag"
[job] [logs] FTR Configs #46 / visualize app annotation listing page search by tag filters by tag

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`searchPlayground`	292	293	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`searchPlayground`	186.2KB	187.6KB	+1.3KB

History

💛 Build #278193 was flaky 0923f78
💛 Build #277470 was flaky 7d618de
💔 Build #275779 failed ed717eb
💔 Build #275712 failed 015ad37
💚 Build #275362 succeeded 9bbdd10

TattdCodeMonkey added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Search v9.1.0 labels Feb 11, 2025

TattdCodeMonkey requested review from a team as code owners February 11, 2025 21:56

TattdCodeMonkey force-pushed the playground/multi-context-fields branch 2 times, most recently from c71a1fb to 9bbdd10 Compare February 11, 2025 21:59

dmlemeshko approved these changes Feb 12, 2025

View reviewed changes

Samiul-TheSoccerFan approved these changes Feb 12, 2025

View reviewed changes

Samiul-TheSoccerFan self-requested a review February 12, 2025 15:17

TattdCodeMonkey requested a review from joemcelroy February 12, 2025 22:08

joemcelroy reviewed Feb 13, 2025

View reviewed changes

yansavitski approved these changes Feb 14, 2025

View reviewed changes

TattdCodeMonkey force-pushed the playground/multi-context-fields branch from ed717eb to 96f1989 Compare February 14, 2025 20:01

TattdCodeMonkey requested a review from joemcelroy February 14, 2025 22:17

TattdCodeMonkey added 7 commits February 18, 2025 22:01

chore(search_playground): improve client type usage to be accurate wi…

9bd765c

…thout casting

feat(search_playground): support multiple context fields per index wh…

705f8fd

…en handling chat messages

test(search_playground): support combobox context field selection

4762d28

refactor(search_playground): dont lose order of selected context fields

d709b5d

feat(search_playground): default context to all source_fields

99b33b7

refactor(search_playground): updated to exclude empty field values fr…

2c8793c

…om the context documents

feat(search_playground): update python code example to support multip…

7d618de

…le context fields

TattdCodeMonkey force-pushed the playground/multi-context-fields branch from dd48e86 to 7d618de Compare February 18, 2025 22:01

Update langchain example to support multiple context fields

0923f78

joemcelroy approved these changes Feb 21, 2025

View reviewed changes

Merge branch 'main' into playground/multi-context-fields

6f5b1ac

TattdCodeMonkey enabled auto-merge (squash) February 21, 2025 16:46

TattdCodeMonkey merged commit ef2ec69 into elastic:main Feb 21, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search][Playground] Support Multiple Context Fields #210703

[Search][Playground] Support Multiple Context Fields #210703

TattdCodeMonkey commented Feb 11, 2025 •

edited

Loading

dmlemeshko left a comment

Samiul-TheSoccerFan left a comment

Samiul-TheSoccerFan Feb 12, 2025

TattdCodeMonkey Feb 12, 2025

Samiul-TheSoccerFan Feb 12, 2025

Samiul-TheSoccerFan Feb 12, 2025

TattdCodeMonkey Feb 12, 2025

TattdCodeMonkey commented Feb 12, 2025

joemcelroy Feb 13, 2025

TattdCodeMonkey Feb 14, 2025

joemcelroy commented Feb 13, 2025

yansavitski left a comment

TattdCodeMonkey commented Feb 14, 2025 •

edited

Loading

joemcelroy commented Feb 18, 2025

TattdCodeMonkey commented Feb 20, 2025 •

edited

Loading

joemcelroy left a comment

TattdCodeMonkey commented Feb 21, 2025

elasticmachine commented Feb 21, 2025

[Search][Playground] Support Multiple Context Fields #210703

[Search][Playground] Support Multiple Context Fields #210703

Conversation

TattdCodeMonkey commented Feb 11, 2025 • edited Loading

Summary

Screenshots

Checklist

dmlemeshko left a comment

Choose a reason for hiding this comment

Samiul-TheSoccerFan left a comment

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2025

Choose a reason for hiding this comment

TattdCodeMonkey Feb 12, 2025

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2025

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2025

Choose a reason for hiding this comment

TattdCodeMonkey Feb 12, 2025

Choose a reason for hiding this comment

TattdCodeMonkey commented Feb 12, 2025

joemcelroy Feb 13, 2025

Choose a reason for hiding this comment

TattdCodeMonkey Feb 14, 2025

Choose a reason for hiding this comment

joemcelroy commented Feb 13, 2025

yansavitski left a comment

Choose a reason for hiding this comment

TattdCodeMonkey commented Feb 14, 2025 • edited Loading

joemcelroy commented Feb 18, 2025

TattdCodeMonkey commented Feb 20, 2025 • edited Loading

joemcelroy left a comment

Choose a reason for hiding this comment

TattdCodeMonkey commented Feb 21, 2025

elasticmachine commented Feb 21, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

History

TattdCodeMonkey commented Feb 11, 2025 •

edited

Loading

TattdCodeMonkey commented Feb 14, 2025 •

edited

Loading

TattdCodeMonkey commented Feb 20, 2025 •

edited

Loading