opensearch-docs-cn/_automating-configurations/api/search-workflow.md

50 lines
1.2 KiB
Markdown
Raw Normal View History

Add flow framework documentation (#6257) * Add flow framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add unregister to word list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add note about provisioning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed code font from headings Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add agent documentation links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add experimental label and more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sample templates link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-07 18:44:49 -05:00
---
layout: default
title: Search for a workflow
parent: Workflow APIs
nav_order: 60
---
# Search for 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}
You can retrieve created workflows with their `workflow_id` or search for workflows by using a query matching a field. You can use the `use_case` field to search for similar workflows.
## Path and HTTP methods
```json
GET /_plugins/_flow_framework/workflow/_search
POST /_plugins/_flow_framework/workflow/_search
```
#### Example request: All created workflows
```json
GET /_plugins/_flow_framework/workflow/_search
{
"query": {
Add flow framework documentation (#6257) * Add flow framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add unregister to word list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add note about provisioning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed code font from headings Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add agent documentation links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add experimental label and more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sample templates link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-07 18:44:49 -05:00
"match_all": {}
}
}
```
{% include copy-curl.html %}
#### Example request: All workflows with a `use_case` of `REMOTE_MODEL_DEPLOYMENT`
```json
GET /_plugins/_flow_framework/workflow/_search
{
"query": {
Add flow framework documentation (#6257) * Add flow framework documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Tech review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/create-workflow.md Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add callout of edges being optional Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add unregister to word list Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add registering local pretrained and custom models Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/deprovision-workflow.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Added Flow Framework plugin to Vale Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/api/get-workflow-status.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Add note about provisioning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _automating-workflows/index.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _automating-workflows/workflow-steps.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * More editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Removed code font from headings Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add agent documentation links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add experimental label and more links Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Add sample templates link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a tracking issue to warning Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Owais Kazi <owaiskazi19@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-07 18:44:49 -05:00
"match": {
"use_case": "REMOTE_MODEL_DEPLOYMENT"
}
}
}
```
{% include copy-curl.html %}
#### Example response
OpenSearch responds with a list of workflow templates matching the search parameters.