Update workflow template documentation #6883
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
requested review from
hdhalter,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
amitgalitz
reviewed
Apr 4, 2024
| @@ -6,9 +6,11 @@ nav_order: 25 | |||
|
|
|||
| # Workflow templates | |||
|
|
|||
| OpenSearch provides several workflow templates for some common machine learning (ML) use cases, such as semantic or conversational search. | |||
| OpenSearch provides several workflow templates for some common machine learning (ML) use cases. Using a template simplifies complex setups required for use cases like semantic or conversational search. | |||
There was a problem hiding this comment.
Can we explain here maybe that we also support pre defined template based on a given use case? and also user can give there own template if they want and then link to create workflow API?
Then we can give example:
amitgalitz
reviewed
Apr 4, 2024
|
|
||
| You can specify a workflow template when you call the [Create Workflow API]({{site.url}}{{site.baseurl}}/automating-configurations/api/create-workflow/). To provision the workflow, specify `provision=true` as a query parameter. For example, you can configure [neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/) by providing the `local_neural_sparse_search_bi_encoder` query parameter as `use_case`, as shown in the following request: | ||
| For example, you can configure the setup required for [neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/) by using the `local_neural_sparse_search_bi_encoder` predefined template. When you use a template, the multi-step setup that required running separate API requests is accomplished with a single request. |
There was a problem hiding this comment.
I am also still unsure if we should have this as the first example as the other one simplifies a lot more complexity vs this one that simplifies 3 API calls only
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
amitgalitz
approved these changes
Apr 4, 2024
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
dbwiddis
approved these changes
Apr 4, 2024
Co-authored-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
vagimeli
approved these changes
Apr 4, 2024
| @@ -16,7 +16,7 @@ You can automate complex OpenSearch setup and preprocessing tasks by providing t | |||
| In OpenSearch 2.12, configuration automation is limited to ML tasks. | |||
| {: .info} | |||
|
|
|||
| OpenSearch use case templates provide a compact description of the setup process in a JSON or YAML document. These templates describe automated workflow configurations for conversational chat or query generation, AI connectors, tools, agents, and other components that prepare OpenSearch as a backend for generative models. For template examples, see [Sample templates](https://github.com/opensearch-project/flow-framework/tree/main/sample-templates). | |||
| OpenSearch use case templates provide a compact description of the setup process in a JSON or YAML document. These templates describe automated workflow configurations for conversational chat or query generation, AI connectors, tools, agents, and other components that prepare OpenSearch as a backend for generative models. For custom template examples, see [Sample templates](https://github.com/opensearch-project/flow-framework/tree/main/sample-templates). For OpenSearch-provided templates, see [Workflow templates]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-templates/). | |||
There was a problem hiding this comment.
Should AI be defined on first mention?
There was a problem hiding this comment.
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 4, 2024
* Update workflow template documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Explain custom and os-provided templates Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add link to supported templates Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-configurations/workflow-templates.md Co-authored-by: Daniel Widdis <widdis@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Daniel Widdis <widdis@gmail.com> (cherry picked from commit eb55593) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws
pushed a commit
that referenced
this pull request
Apr 4, 2024
* Update workflow template documentation * Tech review comments * Explain custom and os-provided templates * Add link to supported templates * Update _automating-configurations/workflow-templates.md --------- (cherry picked from commit eb55593) Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Daniel Widdis <widdis@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update workflow template documentation
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.