Files
3f7468b504 Add agent framework/throttling/hidden model/OS assistant and update conversational search documentation (#6354)
* Add agent framework documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Add hidden model and API updates

Signed-off-by: Fanit Kolchina <[email protected]>

* Vale error

Signed-off-by: Fanit Kolchina <[email protected]>

* Updated field names

Signed-off-by: Fanit Kolchina <[email protected]>

* Add updating credentials

Signed-off-by: Fanit Kolchina <[email protected]>

* Added tools table

Signed-off-by: Fanit Kolchina <[email protected]>

* Add OpenSearch forum thread for OS Assistant

Signed-off-by: Fanit Kolchina <[email protected]>

* Add tech review for conv search

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

* Add tools

Signed-off-by: Fanit Kolchina <[email protected]>

* Add links to tools

Signed-off-by: Fanit Kolchina <[email protected]>

* More info about tools

Signed-off-by: Fanit Kolchina <[email protected]>

* Tool parameters

Signed-off-by: Fanit Kolchina <[email protected]>

* Update cat-index-tool.md

Signed-off-by: kolchfa-aws <[email protected]>

* Parameter clarification

Signed-off-by: Fanit Kolchina <[email protected]>

* Tech review feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Typo fix

Signed-off-by: Fanit Kolchina <[email protected]>

* More tech review feedback: RAG tool

Signed-off-by: Fanit Kolchina <[email protected]>

* Tech review feedback: memory APis

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _ml-commons-plugin/agents-tools/index.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/opensearch-assistant.md

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/agents-tools/tools/ppl-tool.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]>

* Separated search and get APIs and add conversational flow agent

Signed-off-by: Fanit Kolchina <[email protected]>

* More parameters for PPL tool

Signed-off-by: Fanit Kolchina <[email protected]>

* Added more parameters

Signed-off-by: Fanit Kolchina <[email protected]>

* Tech review feedback: PPL tool

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]>

* Rename to automating configurations

Signed-off-by: Fanit Kolchina <[email protected]>

* Editorial comments on the new text

Signed-off-by: Fanit Kolchina <[email protected]>

* Add parameter to PPl tool

Signed-off-by: Fanit Kolchina <[email protected]>

* Changed link to configurations

Signed-off-by: Fanit Kolchina <[email protected]>

* Rate limiter feedback and added 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: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2024-02-20 12:09:31 -05:00

1.3 KiB

layout, title, parent, has_children, has_toc, nav_order
layout title parent has_children has_toc nav_order
default Train and Predict APIs ML Commons APIs true false 30

Train and Predict APIs

The ML Commons API lets you train machine learning (ML) algorithms synchronously and asynchronously, make predictions with that trained model, and train and predict with the same dataset.

To train tasks through the API, three inputs are required:

  • Algorithm name: Must be one of a FunctionName. This determines what algorithm the ML Engine runs. To add a new function, see How To Add a New Function.
  • Model hyperparameters: Adjust these parameters to improve model accuracy.
  • Input data: The data that trains the ML model, or applies the ML models to predictions. You can input data in two ways, query against your index or use a data frame.

ML Commons supports the following Train and Predict APIs: