Complete conversions between config <-> form <-> template (#156)

Signed-off-by: Tyler Ohlsen <[email protected]>
opensearch-project · May 16, 2024 · 0d73288 · 0d73288
1 parent dcef748
commit 0d73288
Show file tree

Hide file tree

Showing 10 changed files with 208 additions and 303 deletions.
diff --git a/common/constants.ts b/common/constants.ts
@@ -119,6 +119,19 @@ export const NEURAL_SPARSE_TOKENIZER_TRANSFORMER = {
   version: '1.0.1',
 } as PretrainedSparseEncodingModel;
 
+/**
+ * Various constants pertaining to Workflow configs
+ */
+
+export enum PROCESSOR_TYPE {
+  MODEL = 'model_processor',
+}
+
+export enum MODEL_TYPE {
+  TEXT_EMBEDDING = 'text_embedding',
+  SPARSE_ENCODER = 'sparse_encoder',
+}
+
 /**
  * Various constants pertaining to the drag-and-drop UI components
  */

diff --git a/common/interfaces.ts b/common/interfaces.ts
@@ -6,7 +6,12 @@
 import { Node, Edge } from 'reactflow';
 import { FormikValues } from 'formik';
 import { ObjectSchema } from 'yup';
-import { COMPONENT_CLASS, COMPONENT_CATEGORY } from './constants';
+import {
+  COMPONENT_CLASS,
+  COMPONENT_CATEGORY,
+  PROCESSOR_TYPE,
+  MODEL_TYPE,
+} from './constants';
 
 export type Index = {
   name: string;
@@ -42,8 +47,16 @@ export interface IConfig {
   metadata?: IConfigMetadata;
 }
 
+export interface IProcessorConfig extends IConfig {
+  type: PROCESSOR_TYPE;
+}
+
+export interface IModelProcessorConfig extends IProcessorConfig {
+  modelType: MODEL_TYPE;
+}
+
 export type EnrichConfig = {
-  processors: IConfig[];
+  processors: IProcessorConfig[];
 };
 
 export type IndexConfig = {
@@ -63,8 +76,8 @@ export type SearchConfig = {
 };
 
 export type WorkflowConfig = {
-  ingest?: IngestConfig;
-  search?: SearchConfig;
+  ingest: IngestConfig;
+  search: SearchConfig;
 };
 
 export type WorkflowFormValues = {

diff --git a/public/configs/ingest_processors/base_ingest_processor.ts b/public/configs/ingest_processors/base_ingest_processor.ts
@@ -10,10 +10,8 @@ import { BaseConfig } from '../base_config';
  */
 export abstract class BaseIngestProcessor extends BaseConfig {
   name: string;
-  type: string;
   constructor() {
     super();
     this.name = '';
-    this.type = '';
   }
 }
diff --git a/public/configs/ingest_processors/model_processor.ts b/public/configs/ingest_processors/model_processor.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { MODEL_TYPE } from '../../../common';
+import { BaseIngestProcessor } from './base_ingest_processor';
+
+/**
+ * A base model processor config
+ */
+export abstract class ModelProcessor extends BaseIngestProcessor {
+  type: MODEL_TYPE;
+  constructor() {
+    super();
+  }
+}
diff --git a/public/configs/ingest_processors/text_embedding_processor.ts b/public/configs/ingest_processors/text_embedding_processor.ts
@@ -3,18 +3,19 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { MODEL_TYPE } from '../../../common';
 import { generateId } from '../../utils';
-import { BaseIngestProcessor } from './base_ingest_processor';
+import { ModelProcessor } from './model_processor';
 
 /**
  * A specialized text embedding processor config
  */
-export class TextEmbeddingProcessor extends BaseIngestProcessor {
+export class TextEmbeddingProcessor extends ModelProcessor {
   constructor() {
     super();
     this.id = generateId('text_embedding_processor');
     this.name = 'Text embedding processor';
-    this.type = 'text_embedding';
+    this.type = MODEL_TYPE.TEXT_EMBEDDING;
     this.fields = [
       {
         label: 'Text Embedding Model',

diff --git a/public/pages/workflow_detail/resizable_workspace.tsx b/public/pages/workflow_detail/resizable_workspace.tsx
@@ -19,6 +19,7 @@ import {
   ReactFlowEdge,
   WorkflowFormValues,
   WorkflowSchema,
+  WorkflowConfig,
 } from '../../../common';
 import {
   APP_PATH,
@@ -222,7 +223,10 @@ export function ResizableWorkspace(props: ResizableWorkspaceProps) {
         setIsSaving(false);
       } else {
         setFormValidOnSubmit(true);
-        const updatedConfig = formikToUiConfig(formikProps.values);
+        const updatedConfig = formikToUiConfig(
+          formikProps.values,
+          workflow?.ui_metadata?.config as WorkflowConfig
+        );
         const updatedWorkflow = {
           ...workflow,
           ui_metadata: {