Minor improvements (#534)

Signed-off-by: Tyler Ohlsen <[email protected]>
opensearch-project · Dec 13, 2024 · 4a9db55 · 4a9db55
1 parent 6f8cbae
commit 4a9db55
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 83 deletions.
diff --git a/common/constants.ts b/common/constants.ts
@@ -115,7 +115,6 @@ export enum WORKFLOW_TYPE {
   SEMANTIC_SEARCH = 'Semantic search',
   MULTIMODAL_SEARCH = 'Multimodal search',
   HYBRID_SEARCH = 'Hybrid search',
-  SENTIMENT_ANALYSIS = 'Sentiment analysis',
   RAG = 'Retrieval-augmented generation',
   CUSTOM = 'Custom',
   UNKNOWN = 'Unknown',
@@ -174,6 +173,8 @@ export const ML_INFERENCE_RESPONSE_DOCS_LINK =
   'https://opensearch.org/docs/latest/search-plugins/search-pipelines/ml-inference-search-response/#request-fields';
 export const ML_CHOOSE_MODEL_LINK =
   'https://opensearch.org/docs/latest/ml-commons-plugin/integrating-ml-models/#choosing-a-model';
+export const ML_REMOTE_MODEL_LINK =
+  'https://opensearch.org/docs/latest/ml-commons-plugin/remote-models/index/';
 export const TEXT_CHUNKING_PROCESSOR_LINK =
   'https://opensearch.org/docs/latest/ingest-pipelines/processors/text-chunking/';
 export const CREATE_WORKFLOW_LINK =
@@ -206,7 +207,6 @@ export const SHARED_OPTIONAL_FIELDS = ['max_chunk_limit', 'description', 'tag'];
 export const DEFAULT_TEXT_FIELD = 'my_text';
 export const DEFAULT_VECTOR_FIELD = 'my_embedding';
 export const DEFAULT_IMAGE_FIELD = 'my_image';
-export const DEFAULT_LABEL_FIELD = 'label';
 export const DEFAULT_LLM_RESPONSE_FIELD = 'llm_response';
 
 /**
@@ -239,15 +239,6 @@ export const TERM_QUERY_TEXT = {
     },
   },
 };
-export const TERM_QUERY_LABEL = {
-  query: {
-    term: {
-      [LABEL_FIELD_PATTERN]: {
-        value: QUERY_TEXT_PATTERN,
-      },
-    },
-  },
-};
 export const KNN_QUERY = {
   _source: {
     excludes: [VECTOR_FIELD_PATTERN],

diff --git a/public/pages/workflow_detail/workflow_inputs/input_fields/model_field.tsx b/public/pages/workflow_detail/workflow_inputs/input_fields/model_field.tsx
@@ -15,13 +15,15 @@ import {
   EuiCompressedSuperSelect,
   EuiSuperSelectOption,
   EuiText,
+  EuiSmallButton,
 } from '@elastic/eui';
 import {
   MODEL_STATE,
   WorkflowFormValues,
   ModelFormValue,
   IConfigField,
   ML_CHOOSE_MODEL_LINK,
+  ML_REMOTE_MODEL_LINK,
 } from '../../../../../common';
 import { AppState } from '../../../../store';
 
@@ -45,6 +47,7 @@ export function ModelField(props: ModelFieldProps) {
   // re-fetch here as it could overload client-side if user clicks back and forth /
   // keeps re-rendering this component (and subsequently re-fetching data) as they're building flows
   const models = useSelector((state: AppState) => state.ml.models);
+  //const models = {};
 
   const { errors, touched, values } = useFormikContext<WorkflowFormValues>();
 
@@ -83,6 +86,31 @@ export function ModelField(props: ModelFieldProps) {
             <EuiSpacer size="s" />
           </>
         )}
+      {isEmpty(deployedModels) && (
+        <>
+          <EuiCallOut
+            size="s"
+            title="No deployed models found"
+            iconType={'alert'}
+            color="warning"
+          >
+            <EuiText size="s">
+              To create and deploy models and make them accessible in
+              OpenSearch, see documentation.
+            </EuiText>
+            <EuiSpacer size="s" />
+            <EuiSmallButton
+              target="_blank"
+              href={ML_REMOTE_MODEL_LINK}
+              iconSide="right"
+              iconType={'popout'}
+            >
+              Documentation
+            </EuiSmallButton>
+          </EuiCallOut>
+          <EuiSpacer size="s" />
+        </>
+      )}
       <Field name={props.fieldPath}>
         {({ field, form }: FieldProps) => {
           return (
@@ -98,6 +126,7 @@ export function ModelField(props: ModelFieldProps) {
               helpText={'The model ID.'}
             >
               <EuiCompressedSuperSelect
+                disabled={isEmpty(deployedModels)}
                 options={deployedModels.map(
                   (option) =>
                     ({

diff --git a/public/pages/workflows/new_workflow/quick_configure_inputs.tsx b/public/pages/workflows/new_workflow/quick_configure_inputs.tsx
@@ -19,7 +19,6 @@ import {
   BEDROCK_DIMENSIONS,
   COHERE_DIMENSIONS,
   DEFAULT_IMAGE_FIELD,
-  DEFAULT_LABEL_FIELD,
   DEFAULT_LLM_RESPONSE_FIELD,
   DEFAULT_TEXT_FIELD,
   DEFAULT_VECTOR_FIELD,
@@ -87,13 +86,6 @@ export function QuickConfigureInputs(props: QuickConfigureInputsProps) {
         };
         break;
       }
-      case WORKFLOW_TYPE.SENTIMENT_ANALYSIS: {
-        defaultFieldValues = {
-          textField: DEFAULT_TEXT_FIELD,
-          labelField: DEFAULT_LABEL_FIELD,
-        };
-        break;
-      }
       case WORKFLOW_TYPE.RAG: {
         defaultFieldValues = {
           textField: DEFAULT_TEXT_FIELD,
@@ -188,17 +180,13 @@ export function QuickConfigureInputs(props: QuickConfigureInputsProps) {
             <EuiCompressedFormRow
               fullWidth={true}
               label={
-                props.workflowType === WORKFLOW_TYPE.SENTIMENT_ANALYSIS
-                  ? 'Model'
-                  : props.workflowType === WORKFLOW_TYPE.RAG
+                props.workflowType === WORKFLOW_TYPE.RAG
                   ? 'Large language model'
                   : 'Embedding model'
               }
               isInvalid={false}
               helpText={
-                props.workflowType === WORKFLOW_TYPE.SENTIMENT_ANALYSIS
-                  ? 'The sentiment analysis model'
-                  : props.workflowType === WORKFLOW_TYPE.RAG
+                props.workflowType === WORKFLOW_TYPE.RAG
                   ? 'The large language model to generate user-friendly responses'
                   : 'The model to generate embeddings'
               }
@@ -245,9 +233,7 @@ export function QuickConfigureInputs(props: QuickConfigureInputsProps) {
               label={'Text field'}
               isInvalid={false}
               helpText={`The name of the text document field to be ${
-                props.workflowType === WORKFLOW_TYPE.SENTIMENT_ANALYSIS
-                  ? 'analyzed'
-                  : props.workflowType === WORKFLOW_TYPE.RAG
+                props.workflowType === WORKFLOW_TYPE.RAG
                   ? 'used as context to the large language model (LLM)'
                   : 'embedded'
               }`}
@@ -328,25 +314,6 @@ export function QuickConfigureInputs(props: QuickConfigureInputsProps) {
                 </EuiCompressedFormRow>
               </>
             )}
-            {props.workflowType === WORKFLOW_TYPE.SENTIMENT_ANALYSIS && (
-              <EuiCompressedFormRow
-                fullWidth={true}
-                label={'Label field'}
-                isInvalid={false}
-                helpText="The name of the document field containing the sentiment label"
-              >
-                <EuiCompressedFieldText
-                  fullWidth={true}
-                  value={fieldValues?.labelField || ''}
-                  onChange={(e) => {
-                    setFieldValues({
-                      ...fieldValues,
-                      labelField: e.target.value,
-                    });
-                  }}
-                />
-              </EuiCompressedFormRow>
-            )}
             {props.workflowType === WORKFLOW_TYPE.RAG && (
               <>
                 <EuiCompressedFormRow

diff --git a/public/pages/workflows/new_workflow/quick_configure_modal.tsx b/public/pages/workflows/new_workflow/quick_configure_modal.tsx
@@ -198,8 +198,7 @@ function injectQuickConfigureFields(
     switch (workflow.ui_metadata?.type) {
       case WORKFLOW_TYPE.SEMANTIC_SEARCH:
       case WORKFLOW_TYPE.HYBRID_SEARCH:
-      case WORKFLOW_TYPE.MULTIMODAL_SEARCH:
-      case WORKFLOW_TYPE.SENTIMENT_ANALYSIS: {
+      case WORKFLOW_TYPE.MULTIMODAL_SEARCH: {
         if (!isEmpty(quickConfigureFields) && workflow.ui_metadata?.config) {
           workflow.ui_metadata.config = updateIngestProcessors(
             workflow.ui_metadata.config,

diff --git a/public/pages/workflows/new_workflow/utils.ts b/public/pages/workflows/new_workflow/utils.ts
@@ -20,7 +20,6 @@ import {
   FETCH_ALL_QUERY,
   customStringify,
   TERM_QUERY_TEXT,
-  TERM_QUERY_LABEL,
   MULTIMODAL_SEARCH_QUERY_BOOL,
   IProcessorConfig,
   VECTOR_TEMPLATE_PLACEHOLDER,
@@ -50,10 +49,6 @@ export function enrichPresetWorkflowWithUiMetadata(
       uiMetadata = fetchHybridSearchMetadata();
       break;
     }
-    case WORKFLOW_TYPE.SENTIMENT_ANALYSIS: {
-      uiMetadata = fetchSentimentAnalysisMetadata();
-      break;
-    }
     case WORKFLOW_TYPE.RAG: {
       uiMetadata = fetchRAGMetadata();
       break;
@@ -175,7 +170,7 @@ export function fetchMultimodalSearchMetadata(): UIState {
   baseState.config.search.enrichRequest.processors = [
     injectQueryTemplateInProcessor(
       new MLSearchRequestProcessor().toObj(),
-      MULTIMODAL_SEARCH_QUERY_BOOL
+      KNN_QUERY
     ),
   ];
   return baseState;
@@ -204,21 +199,6 @@ export function fetchHybridSearchMetadata(): UIState {
   return baseState;
 }
 
-export function fetchSentimentAnalysisMetadata(): UIState {
-  let baseState = fetchEmptyMetadata();
-  baseState.type = WORKFLOW_TYPE.SENTIMENT_ANALYSIS;
-  baseState.config.ingest.enrich.processors = [new MLIngestProcessor().toObj()];
-  baseState.config.ingest.index.name.value = generateId('knn_index', 6);
-  baseState.config.ingest.index.settings.value = customStringify({
-    [`index.knn`]: true,
-  });
-  baseState.config.search.request.value = customStringify(TERM_QUERY_LABEL);
-  baseState.config.search.enrichRequest.processors = [
-    new MLSearchRequestProcessor().toObj(),
-  ];
-  return baseState;
-}
-
 export function fetchRAGMetadata(): UIState {
   let baseState = fetchEmptyMetadata();
   baseState.type = WORKFLOW_TYPE.RAG;

diff --git a/public/pages/workflows/workflow_list/workflow_list.tsx b/public/pages/workflows/workflow_list/workflow_list.tsx
@@ -150,14 +150,14 @@ export function WorkflowList(props: WorkflowListProps) {
           <EuiFlyoutBody>
             {selectedWorkflow?.ui_metadata === undefined ||
             isEmpty(selectedWorkflow?.ui_metadata) ||
-            selectedWorkflow?.ui_metadata?.type === WORKFLOW_TYPE.CUSTOM ? (
+            selectedWorkflow?.ui_metadata?.type === WORKFLOW_TYPE.UNKNOWN ? (
               <EuiEmptyPrompt
                 title={<h2>Invalid workflow type</h2>}
                 titleSize="s"
                 body={
                   <>
                     <EuiText size="s">
-                      Displaying resources from custom workflows is not
+                      Displaying resources from workflows of unknown type is not
                       currently supported.
                     </EuiText>
                   </>

diff --git a/server/resources/templates/sentiment_analysis.json b/server/resources/templates/sentiment_analysis.json