Support basic semantic search with preset workflow template #121

ohltyler · 2024-04-02T22:32:04Z

Description

This PR updates several interfaces and improves upon some of the base building blocks to support end-to-end creation of a workflow template for basic semantic search, with heavy UI guardrails. Specifically:

adds detailed hardcoded logic for toWorkspaceFlow() and toTemplateFlows() for a basic semantic search use case. toWorkspaceFlow() is used to load a static set of draggable nodes/edges on the UI. toTemplateFlows() is used to convert expected & validated field data (model ID, etc.) and populate a preset template configuration used for creating the actual workflow via create workflow API. Both of these will become more generic and flexible over time; this is to prove out an initial use case
updates IComponentField schema to support more information for a particular field, including help text, links to external documentation, etc. UI components parse and render them accordingly
onboards and integrates with the ML commons plugin, and the search model API, including integrating with redux store to persist fetched models on client-side. This is used for auto-populating available model IDs in the dropdown (see video below for example)
minor update to ReactFlowProvider to move one layer up so ResizableWorkspace can use useReactFlow() hook. This was previously downscoped too far in the previous PR.
simplifies the ReactFlow edge to use the preset ones provided from ReactFlow, and block deletion. This is part of the ongoing effort to downscope the amount of flexibility and user customization on the flow builder page for now
integrates with ui_metadata field in the backend template to persist UI flow data
updates template schema to support user_inputs and previous_node_inputs
add optional provision field in createWorkflow() (currently not integrated into buttons yet)
minor styling updates (preventing overflow scrollbars, vh tuning)

Screenshot of updated component inputs with help text and external links. Also includes the Existing/New tabs but scoped down to only allow New for now - this may change as scope for initial release is finalized.

Demo video showing end-to-end creation of a (mostly hardcoded) template configuration, provisioning the template, and executing semantic search with the newly-created ingest pipeline and knn index.

demo-e2e.webm

Issues Resolved

Makes progress on #73

Check List

Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…ogic Signed-off-by: Tyler Ohlsen <[email protected]>

Signed-off-by: Tyler Ohlsen <[email protected]>

codecov · 2024-04-02T22:40:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 22.18%. Comparing base (3eb94a5) to head (4c109fe).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #121      +/-   ##
==========================================
+ Coverage   21.92%   22.18%   +0.26%     
==========================================
  Files          56       57       +1     
  Lines         812      870      +58     
  Branches       82       92      +10     
==========================================
+ Hits          178      193      +15     
- Misses        630      673      +43     
  Partials        4        4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

owaiskazi19

Overall LG. Added few comments

owaiskazi19 · 2024-04-03T16:40:18Z

common/utils.ts

 ): TemplateFlows {
+  const textEmbeddingTransformerNodeId = Object.keys(formValues).find((key) =>
+    key.includes('text_embedding')


Constant for text_embedding?

Yeah this entire fn will be more generic. Just a first set of hardcoded vals to get e2e working.

See TODO on line 24.

owaiskazi19 · 2024-04-03T16:40:26Z

common/utils.ts

+    key.includes('text_embedding')
+  ) as string;
+  const knnIndexerNodeId = Object.keys(formValues).find((key) =>
+    key.includes('knn')


Same as above

same as above :)

owaiskazi19 · 2024-04-03T16:42:07Z

common/utils.ts

+                      space_type: 'l2',
+                      name: 'hnsw',
+                      parameters: {},
+                    },


Why do we have static values defined here? Aren't we taking the inputs from the user or future plans of doing so?

same as above. As a reminder in the description, this is all hardcoded right now for the purpose of getting an initial use case possible

owaiskazi19 · 2024-04-03T16:43:38Z

public/pages/workflow_detail/component_details/component_inputs.tsx

+            componentFields={props.selectedComponent.data.fields}
+            onFormChange={props.onFormChange}
+          />
+        )}


Duplication can be avoided here

<EuiSpacer size="s" /> {selectedTabId === TAB.NEW || selectedTabId === TAB.EXISTING && ( <InputFieldList componentId={props.selectedComponent.id} componentFields={ selectedTabId === TAB.NEW ? props.selectedComponent.data.createFields : props.selectedComponent.data.fields } onFormChange={props.onFormChange} /> )}

Good idea, will update

owaiskazi19 · 2024-04-03T16:44:13Z

public/pages/workflow_detail/component_details/input_field_list.tsx

                  onFormChange={props.onFormChange}
                />
-                <EuiSpacer size="s" />
+                <EuiSpacer size="m" />


Can we have ENUM constant for the size for EuiSpacer?

Sure, will add

owaiskazi19 · 2024-04-03T16:45:25Z

public/pages/workflow_detail/component_details/input_fields/select_field.tsx

+    if (props.field.selectType === 'model' && models) {
+      setOptions(Object.keys(models));
+    }
+  }, [models]);


Do we need error handling here?

There is no chance for NPEs as models is initialized to an empty map, options is initialized to an empty arr, and selectType can be null/undefined, in which case the if block will fail. If there was any errors, it will be logged when fetching models, and will just show as an empty dropdown list.

We will have any errors in redux store bubbled up via toasts or static callouts at the top of the pages; there is no UX for that for now.

owaiskazi19 · 2024-04-03T16:46:06Z

public/pages/workflow_detail/workspace/resizable_workspace.tsx

+      };
+      console.debug(
+        `There is no saved UI flow for workflow: ${workflowCopy.name}. Generating a default one.`
+      );


Do we just do a debug or some alert here as well?

I'm keeping as just a logged debug for now. It's not considered an error as it would just indicate users loading an existing workflow with no ui metadata.

kamingleung · 2024-04-03T17:30:41Z

What's the difference between Existing / New tabs? Can this be stateless?

Signed-off-by: Tyler Ohlsen <[email protected]>

ohltyler · 2024-04-03T17:36:22Z

What's the difference between Existing / New tabs? Can this be stateless?

Just what I have as a placeholder for now, with the idea that some components may allow using existing resources/data vs. creating new. Example being creating a new knn index or using an existing one, or creating a new model or using an existing one. This can easily be removed, in the current examples I have existing entirely disabled.

Signed-off-by: Tyler Ohlsen <[email protected]> (cherry picked from commit d5ba601)

) Signed-off-by: Tyler Ohlsen <[email protected]> (cherry picked from commit d5ba601) Co-authored-by: Tyler Ohlsen <[email protected]>

ohltyler added 9 commits April 1, 2024 12:02

Fix reactflow context; set up hardcoded flow -> template conversion l…

c90f721

…ogic Signed-off-by: Tyler Ohlsen <[email protected]>

Switch inputs to createFields; clean up sample template

2bb403a

Signed-off-by: Tyler Ohlsen <[email protected]>

Remove custom edge for now

ad260ee

Signed-off-by: Tyler Ohlsen <[email protected]>

Refactor into uiMetadata; support for workflow creation

691695a

Signed-off-by: Tyler Ohlsen <[email protected]>

Support optional provision in createWorkflow; update ui_metadata field

e7e30b7

Signed-off-by: Tyler Ohlsen <[email protected]>

Get substitution working; re-add ui_metadata with backend fix

1bcfa43

Signed-off-by: Tyler Ohlsen <[email protected]>

Fix overflow styles

1433839

Signed-off-by: Tyler Ohlsen <[email protected]>

Improve IComponentField schema; support hint and links on inputs

95a4df7

Signed-off-by: Tyler Ohlsen <[email protected]>

Onboard ML plugin and search models API; integrate into select field;

400a4dd

Signed-off-by: Tyler Ohlsen <[email protected]>

ohltyler added server rapid workflow details workflow editor labels Apr 2, 2024

ohltyler requested review from dbwiddis, owaiskazi19, joshpalis, amitgalitz and jackiehanyang as code owners April 2, 2024 22:32

opensearch-trigger-bot bot added the backport 2.x label Apr 2, 2024

add reducer comments

854b4da

Signed-off-by: Tyler Ohlsen <[email protected]>

ohltyler changed the title ~~Update initial building blocks to support semantic search via template~~ Support basic semantic search with preset workflow template Apr 2, 2024

owaiskazi19 reviewed Apr 3, 2024

View reviewed changes

address minor comments

4c109fe

Signed-off-by: Tyler Ohlsen <[email protected]>

owaiskazi19 approved these changes Apr 3, 2024

View reviewed changes

ohltyler merged commit d5ba601 into opensearch-project:main Apr 3, 2024
8 checks passed

ohltyler deleted the ss-blocks branch April 3, 2024 18:59

opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 3, 2024

Support basic semantic search with preset workflow template (#121)

455526b

Signed-off-by: Tyler Ohlsen <[email protected]> (cherry picked from commit d5ba601)

opensearch-trigger-bot bot mentioned this pull request Apr 3, 2024

[Backport 2.x] Support basic semantic search with preset workflow template #122

Merged

ohltyler added a commit that referenced this pull request Apr 3, 2024

Support basic semantic search with preset workflow template (#121) (#122

8184c39

) Signed-off-by: Tyler Ohlsen <[email protected]> (cherry picked from commit d5ba601) Co-authored-by: Tyler Ohlsen <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support basic semantic search with preset workflow template #121

Support basic semantic search with preset workflow template #121

ohltyler commented Apr 2, 2024 •

edited

Loading

codecov bot commented Apr 2, 2024 •

edited

Loading

owaiskazi19 left a comment

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024 •

edited

Loading

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

owaiskazi19 Apr 3, 2024

ohltyler Apr 3, 2024

kamingleung commented Apr 3, 2024

ohltyler commented Apr 3, 2024 •

edited

Loading

Support basic semantic search with preset workflow template #121

Support basic semantic search with preset workflow template #121

Conversation

ohltyler commented Apr 2, 2024 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Apr 2, 2024 • edited Loading

Codecov Report

owaiskazi19 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

owaiskazi19 Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kamingleung commented Apr 3, 2024

ohltyler commented Apr 3, 2024 • edited Loading

ohltyler commented Apr 2, 2024 •

edited

Loading

codecov bot commented Apr 2, 2024 •

edited

Loading

owaiskazi19 Apr 3, 2024 •

edited

Loading

ohltyler commented Apr 3, 2024 •

edited

Loading