Get offline batch inference details using task API in m #8305
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: Bhavana Ramaram <[email protected]>
rbhavna
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
natebower
reviewed
Sep 17, 2024
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Sep 17, 2024
Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
approved these changes
Sep 17, 2024
kolchfa-aws
added
release-notes
Zhangxunmt
reviewed
Sep 17, 2024
| @@ -31,7 +31,7 @@ POST /_plugins/_ml/models/<model_id>/_batch_predict | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| Before using the Batch Predict API, you need to create a connector to the externally hosted model. For example, to create a connector to an OpenAI `text-embedding-ada-002` model, send the following request: | |||
| Before using the Batch Predict API, you need to create a connector to the externally hosted model. For example, to create a connector to an OpenAI `text-embedding-ada-002` model, send the following request. The optional `action_type` paramter supports canceling the batch job running on OpenAI: | |||
There was a problem hiding this comment.
The optional action_type parameter allows for checking the status or canceling a batch job running on OpenAI.
There was a problem hiding this comment.
Can we have something like this:
Before using the Batch Predict API, you need to create a connector to the externally hosted model. For example, to create a connector to an OpenAI text-embedding-ada-002 model, send the following request. The action_type cancel_batch_predict is optional and it supports canceling the batch job running on OpenAI:
Zhangxunmt
approved these changes
Sep 17, 2024
kolchfa-aws
reviewed
Sep 17, 2024
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
natebower
approved these changes
Sep 17, 2024
| @@ -31,7 +31,13 @@ POST /_plugins/_ml/models/<model_id>/_batch_predict | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| Before using the Batch Predict API, you need to create a connector to the externally hosted model. For example, to create a connector to an OpenAI `text-embedding-ada-002` model, send the following request. The optional `action_type` parameter supports canceling the batch job running on OpenAI: | |||
| Before using the Batch Predict API, you need to create a connector to the externally hosted model. For every action, specify the `action_type` parameter that describes the action: | |||
There was a problem hiding this comment.
There are extra spaces before "For every" and after "specify the". I would say "For each action".
Signed-off-by: Fanit Kolchina <[email protected]>
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
…roject#8305) * get offline batch inference details using task API in ml Signed-off-by: Bhavana Ramaram <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Typo fix 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]> * Update _ml-commons-plugin/api/model-apis/batch-predict.md Signed-off-by: kolchfa-aws <[email protected]> * Update _ml-commons-plugin/api/model-apis/batch-predict.md Signed-off-by: kolchfa-aws <[email protected]> * Add parameter values Signed-off-by: Fanit Kolchina <[email protected]> * Extra spaces Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Bhavana Ramaram <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
…roject#8305) * get offline batch inference details using task API in ml Signed-off-by: Bhavana Ramaram <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Typo fix 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]> * Update _ml-commons-plugin/api/model-apis/batch-predict.md Signed-off-by: kolchfa-aws <[email protected]> * Update _ml-commons-plugin/api/model-apis/batch-predict.md Signed-off-by: kolchfa-aws <[email protected]> * Add parameter values Signed-off-by: Fanit Kolchina <[email protected]> * Extra spaces Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Bhavana Ramaram <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
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.
Description
Add documentation for getting offline batch inference details using task API in ml-commons
Issues Resolved
closes #8210
Version
2.17
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.