Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for new workflow steps #6740

Merged
merged 2 commits into from
Mar 21, 2024
Merged

Add documentation for new workflow steps #6740

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ec2fa2
Added documentation for new workflow steps
owaiskazi19 Mar 20, 2024
d3c8156
Apply suggestions from code review
kolchfa-aws Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _automating-configurations/workflow-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ The following table lists the workflow step types. The `user_inputs` fields for
|`register_agent` |[Register Agent API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/) |Registers an agent as part of the ML Commons Agent Framework. |
|`delete_agent` |[Delete Agent API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/) |Deletes an agent. |
|`create_tool` |No API | A special-case non-API step encapsulating the specification of a tool for an agent in the ML Commons Agent Framework. These will be listed as `previous_node_inputs` for the appropriate register agent step, with the value set to `tools`. |
|`create_index`|[Create Index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/) | Creates a new OpenSearch index. The inputs include `index_name`, which should be the name of the index to be created, and `configurations`, which contains the payload body of a regular REST request for creating an index.
|`create_ingest_pipeline`|[Create Ingest Pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/) | Creates or updates an ingest pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating an ingest pipeline.
kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved
|`create_search_pipeline`|[Create Search Pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/creating-search-pipeline/) | Creates or updates a search pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating a search pipeline.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of the other step types in this table detail the inputs unless they have special behavior (register+deploy).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These steps does have special behavior. We are passing the complete rest payload under a new field called configurations.

kolchfa-aws marked this conversation as resolved.
Show resolved Hide resolved

## Additional fields

Expand Down
Loading