Add flow framework documentation (#6257)

* Add flow framework documentation Signed-off-by: Fanit Kolchina <[email protected]> * Tech review comments Signed-off-by: Fanit Kolchina <[email protected]> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <[email protected]> * Add unregister to word list Signed-off-by: Fanit Kolchina <[email protected]> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * More editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Add note about provisioning Signed-off-by: Fanit Kolchina <[email protected]> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * More editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Removed code font from headings Signed-off-by: Fanit Kolchina <[email protected]> * Add agent documentation links Signed-off-by: Fanit Kolchina <[email protected]> * Add experimental label and more links Signed-off-by: Fanit Kolchina <[email protected]> * Add sample templates link Signed-off-by: Fanit Kolchina <[email protected]> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Owais Kazi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Feb 7, 2024 · 6c92b54 · 6c92b54
1 parent e91cf1f
commit 6c92b54
Show file tree

Hide file tree

Showing 20 changed files with 1,510 additions and 1 deletion.
diff --git a/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
@@ -4,6 +4,7 @@ Asynchronous Search plugin
 Crypto plugin
 Cross-Cluster Replication plugin
 Custom Codecs plugin
+Flow Framework plugin
 Maps plugin
 Notebooks plugin
 Notifications plugin

diff --git a/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt b/.github/vale/styles/Vocab/OpenSearch/Words/accept.txt
@@ -20,6 +20,7 @@ Boolean
 [Dd]eallocate
 [Dd]eduplicates?
 [Dd]eduplication
+[Dd]eprovision(s|ed|ing)?
 [Dd]eserialize
 [Dd]eserialization
 Dev
@@ -131,6 +132,7 @@ tebibyte
 [Uu]nigram
 [Uu]nnesting
 [Uu]nrecovered
+[Uu]nregister(s|ed|ing)?
 [Uu]pdatable
 [Uu]psert
 [Ww]alkthrough

diff --git a/_automating-workflows/api/create-workflow.md b/_automating-workflows/api/create-workflow.md
@@ -0,0 +1,255 @@
+---
+layout: default
+title: Create or update a workflow
+parent: Workflow APIs
+nav_order: 10
+---
+
+# Create or update a workflow
+
+This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/flow-framework/issues/475).    
+{: .warning}
+
+Creating a workflow adds the content of a workflow template to the flow framework system index. You can provide workflows in JSON format (by specifying `Content-Type: application/json`) or YAML format (by specifying `Content-Type: application/yaml`). By default, the workflow is validated to help identify invalid configurations, including:
+
+* Workflow steps requiring an OpenSearch plugin that is not installed.
+* Workflow steps relying on previous node input that is provided by those steps.
+* Workflow step fields with invalid values.
+* Workflow graph (node/edge) configurations containing cycles or with duplicate IDs.
+
+To obtain the validation template for workflow steps, call the [Get Workflow Steps API]({{site.url}}{{site.baseurl}}/automating-workflows/api/get-workflow-steps/).
+
+Once a workflow is created, provide its `workflow_id` to other APIs.
+
+The `POST` method creates a new workflow. The `PUT` method updates an existing workflow. 
+
+You can only update a workflow if it has not yet been provisioned.
+{: .note}
+
+## Path and HTTP methods
+
+```json
+POST /_plugins/_flow_framework/workflow
+PUT /_plugins/_flow_framework/workflow/<workflow_id>
+```
+
+## Path parameters
+
+The following table lists the available path parameters. 
+
+| Parameter | Data type | Description |
+| :--- | :--- | :--- |
+| `workflow_id` | String | The ID of the workflow to be updated. Required for the `PUT` method. |
+
+## Query parameters
+
+Workflows are normally created and provisioned in separate steps. However, once you have thoroughly tested the workflow, you can combine the create and provision steps by including the `provision` query parameter:
+
+```json
+POST /_plugins/_flow_framework/workflow?provision=true
+```
+{% include copy-curl.html %}
+
+When set to `true`, the [Provision Workflow API]({{site.url}}{{site.baseurl}}/automating-workflows/api/provision-workflow/) is executed immediately following creation. 
+
+By default, workflows are validated when they are created to ensure that the syntax is valid and that the graph does not contain cycles. This behavior can be controlled with the `validation` query parameter. If `validation` is set to `all`, OpenSearch performs a complete template validation. Any other value of the `validation` parameter suppresses validation, allowing an incomplete/work-in-progress template to be saved. To disable template validation, set `validation` to `none`:
+
+```json
+POST /_plugins/_flow_framework/workflow?validation=none
+```
+{% include copy-curl.html %}
+
+The following table lists the available query parameters. All query parameters are optional.
+
+| Parameter | Data type | Description |
+| :--- | :--- | :--- |
+| `provision` | Boolean | Whether to provision the workflow as part of the request. Default is `false`. |
+| `validation` | String | Whether to validate the workflow. Valid values are `all` (validate the template) and `none` (do not validate the template). Default is `all`. |
+
+## Request fields
+
+The following table lists the available request fields.
+
+|Field	|Data type	|Required/Optional	|Description	|
+|:---	|:---	|:---	|:---	|
+|`name`	|String	|Required	|The name of the workflow.	|
+|`description`	|String	|Optional	|A description of the workflow.	|
+|`use_case`	|String	|Optional	| A use case, which can be used with the Search Workflow API to find related workflows. In the future, OpenSearch may provide some standard use cases to ease categorization, but currently you can use this field to specify custom values.	|
+|`version`	|Object	|Optional	| A key-value map with two fields: `template`, which identifies the template version, and `compatibility`, which identifies a list of minimum required OpenSearch versions.	|
+|`workflows`	|Object	|Optional	|A map of workflows. Presently, only the `provision` key is supported. The value for the workflow key is a key-value map that includes fields for `user_params` and lists of `nodes` and `edges`.	|
+
+#### Example request: Register and deploy an externally hosted model (YAML)
+
+To provide a template in YAML format, specify `Content-Type: application/yaml` in the request header:
+
+```bash
+curl -XPOST "http://localhost:9200/_plugins/_flow_framework/workflow" -H 'Content-Type: application/yaml'
+```
+
+YAML templates permit comments. 
+{: .tip}
+
+The following is an example YAML template for registering and deploying an externally hosted model:
+
+```yaml
+# This name is required
+name: createconnector-registerremotemodel-deploymodel
+# Other fields are optional but useful
+description: This template creates a connector to a remote model, registers it, and
+  deploys that model
+# Other templates with a similar use case can be searched
+use_case: REMOTE_MODEL_DEPLOYMENT
+version:
+  # Templates may be versioned by their authors
+  template: 1.0.0
+  # Compatibility with OpenSearch 2.12.0 and higher and 3.0.0 and higher
+  compatibility:
+  - 2.12.0
+  - 3.0.0
+# One or more workflows can be included, presently only provision is supported
+workflows:
+  provision:
+    # These nodes are the workflow steps corresponding to ML Commons APIs
+    nodes:
+    # This ID must be unique to this workflow
+    - id: create_connector_1
+      # There may be multiple steps with the same type
+      type: create_connector
+      # These inputs match the Create Connector API body
+      user_inputs:
+        name: OpenAI Chat Connector
+        description: The connector to public OpenAI model service for GPT 3.5
+        version: '1'
+        protocol: http
+        parameters:
+          endpoint: api.openai.com
+          model: gpt-3.5-turbo
+        credential:
+          openAI_key: '12345'
+        actions:
+        - action_type: predict
+          method: POST
+          url: https://${parameters.endpoint}/v1/chat/completions
+    # This ID must be unique to this workflow
+    - id: register_model_2
+      type: register_remote_model
+      # This step needs the connector_id produced as an output of the previous step
+      previous_node_inputs:
+        create_connector_1: connector_id
+      # These inputs match the Register Model API body
+      user_inputs:
+        name: openAI-gpt-3.5-turbo
+        function_name: remote
+        description: test model
+    # This ID must be unique to this workflow
+    - id: deploy_model_3
+      type: deploy_model
+      # This step needs the model_id produced as an output of the previous step
+      previous_node_inputs:
+        register_model_2: model_id
+    # Since the nodes include previous_node_inputs these are optional to define
+    # They will be added automatically and included in the stored template
+    # Additional edges may also be added here if required for sequencing
+    edges:
+    - source: create_connector_1
+      dest: register_model_2
+    - source: register_model_2
+      dest: deploy_model_3
+```
+{% include copy-curl.html %}
+
+#### Example request: Register and deploy a remote model (JSON)
+
+To provide a template in JSON format, specify `Content-Type: application/json` in the request header:
+
+```bash
+curl -XPOST "http://localhost:9200/_plugins/_flow_framework/workflow" -H 'Content-Type: application/json'
+```
+The following JSON template is equivalent to the YAML template provided in the previous section: 
+
+```json
+{
+  "name": "createconnector-registerremotemodel-deploymodel",
+  "description": "This template creates a connector to a remote model, registers it, and deploys that model",
+  "use_case": "REMOTE_MODEL_DEPLOYMENT",
+  "version": {
+    "template": "1.0.0",
+    "compatibility": [
+      "2.12.0",
+      "3.0.0"
+    ]
+  },
+  "workflows": {
+    "provision": {
+      "nodes": [
+        {
+          "id": "create_connector_1",
+          "type": "create_connector",
+          "user_inputs": {
+            "name": "OpenAI Chat Connector",
+            "description": "The connector to public OpenAI model service for GPT 3.5",
+            "version": "1",
+            "protocol": "http",
+            "parameters": {
+              "endpoint": "api.openai.com",
+              "model": "gpt-3.5-turbo"
+            },
+            "credential": {
+              "openAI_key": "12345"
+            },
+            "actions": [
+              {
+                "action_type": "predict",
+                "method": "POST",
+                "url": "https://${parameters.endpoint}/v1/chat/completions"
+              }
+            ]
+          }
+        },
+        {
+          "id": "register_model_2",
+          "type": "register_remote_model",
+          "previous_node_inputs": {
+            "create_connector_1": "connector_id"
+          },
+          "user_inputs": {
+            "name": "openAI-gpt-3.5-turbo",
+            "function_name": "remote",
+            "description": "test model"
+          }
+        },
+        {
+          "id": "deploy_model_3",
+          "type": "deploy_model",
+          "previous_node_inputs": {
+            "register_model_2": "model_id"
+          }
+        }
+      ],
+      "edges": [
+        {
+          "source": "create_connector_1",
+          "dest": "register_model_2"
+        },
+        {
+          "source": "register_model_2",
+          "dest": "deploy_model_3"
+        }
+      ]
+    }
+  }
+}
+```
+{% include copy-curl.html %}
+
+#### Example response
+
+OpenSearch responds with the `workflow_id`:
+
+```json
+{
+  "workflow_id" : "8xL8bowB8y25Tqfenm50"
+}
+```
+
+Once you have created a workflow, you can use other workflow APIs with the `workflow_id`.
diff --git a/_automating-workflows/api/delete-workflow.md b/_automating-workflows/api/delete-workflow.md
@@ -0,0 +1,56 @@
+---
+layout: default
+title: Delete a workflow
+parent: Workflow APIs
+nav_order: 80
+---
+
+# Delete a workflow
+
+This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/flow-framework/issues/475).    
+{: .warning}
+
+When you no longer need a workflow template, you can delete it by calling the Delete Workflow API. 
+
+Note that deleting a workflow only deletes the stored template but does not deprovision its resources.  
+
+## Path and HTTP methods
+
+```json
+DELETE /_plugins/_flow_framework/workflow/<workflow_id>
+``` 
+
+## Path parameters
+
+The following table lists the available path parameters. 
+
+| Parameter | Data type | Description |
+| :--- | :--- | :--- |
+| `workflow_id` | String | The ID of the workflow to be retrieved. Required. |
+
+#### Example request
+
+```
+DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50
+```
+{% include copy-curl.html %}
+
+#### Example response
+
+If the workflow exists, a delete response contains the status of the deletion, where the `result` field is set to `deleted` on success or `not_found` if the workflow does not exist (it may have already been deleted):
+
+```json
+{
+  "_index": ".plugins-flow_framework-templates",
+  "_id": "8xL8bowB8y25Tqfenm50",
+  "_version": 2,
+  "result": "deleted",
+  "_shards": {
+    "total": 1,
+    "successful": 1,
+    "failed": 0
+  },
+  "_seq_no": 2,
+  "_primary_term": 1
+}
+```