Add new use cases to ML Inference Search Response Processor #8639

mingshl · 2024-10-31T02:13:51Z

Description

add two use cases to ML Inference Search Response Processor that is supported in 2.18

Version

2.18

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2024-10-31T02:14:01Z

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.

_search-plugins/search-pipelines/ml-inference-search-response.md

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

mingshl · 2024-11-02T06:45:46Z

rebased and made the changes, please help review again @ylwu-amzn

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

natebower

@kolchfa-aws @mingshl Please see my changes and let me know if you have any questions. Thanks!

_search-plugins/search-pipelines/ml-inference-search-response.md

mingshl · 2024-11-04T21:17:21Z

_search-plugins/search-pipelines/ml-inference-search-response.md


-Step 0: Host a model
-The pre-requisite is a registered text similarity model in OpenSearch. For more information about externally hosted models, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/). Here is a sample predict, which requires a text and a text_pair field within inputs field. 
+You must configure an externally hosted LLM for this use case. For more information about externally hosted models, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/). Once you register the LLM, you can use the following request to test it. This request requires providing a `text` and `text_pair` fields within the `inputs` field:


@kolchfa-aws this rerank use case is using a registered text similarity model not llm model

mingshl · 2024-11-04T21:20:25Z

_search-plugins/search-pipelines/ml-inference-search-response.md

@@ -390,12 +390,13 @@ The response confirms that the processor has generated text embeddings in the `p
 }
 ```

-### Example: GENAI use case
+### Example: Externally hosted model


there is a Externally hosted model example at line 99 already. maybe we should come up with other title? @kolchfa-aws

documentation-website/_search-plugins/search-pipelines/ml-inference-search-response.md

Line 99 in faf070f

### Example: Externally hosted model

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws

Thank you, @mingshl! LGTM

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

…ch-project#8639) * add new use cases Signed-off-by: Mingshi Liu <mingshl@amazon.com> * modify use case using rerank processors and use bulk api Signed-off-by: Mingshi Liu <mingshl@amazon.com> * format change suggested by reviewdog Signed-off-by: Mingshi Liu <mingshl@amazon.com> * fix format Signed-off-by: Mingshi Liu <mingshl@amazon.com> * Doc review 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> * Change titles Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Reorder examples Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Mingshi Liu <mingshl@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: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>

mingshl requested review from kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable and epugh as code owners October 31, 2024 02:13

github-actions bot assigned kolchfa-aws Oct 31, 2024

kolchfa-aws added release-notes PR: Include this PR in the automated release notes v2.18.0 3 - Tech review PR: Tech review in progress labels Nov 1, 2024