From 416be3a7fd0fc3325fcac8035d6868867cf02b6c Mon Sep 17 00:00:00 2001 From: Xun Zhang Date: Tue, 30 Jul 2024 11:26:15 -0700 Subject: [PATCH] add more links and mark the api as experimental Signed-off-by: Xun Zhang --- _ml-commons-plugin/api/model-apis/batch-predict.md | 5 +++-- _ml-commons-plugin/api/model-apis/index.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/_ml-commons-plugin/api/model-apis/batch-predict.md b/_ml-commons-plugin/api/model-apis/batch-predict.md index 0a762657c9..1049be0d1e 100644 --- a/_ml-commons-plugin/api/model-apis/batch-predict.md +++ b/_ml-commons-plugin/api/model-apis/batch-predict.md @@ -13,7 +13,7 @@ ML Commons can predict large datasets in an offline asynchronous mode with your For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -For information about connectors and remote models, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/). +For information about connectors and remote models, see [Connecting to externally hosted models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/). For more details of the connector blurprints for batch predict, see [GitHub docs](https://github.com/opensearch-project/ml-commons/tree/main/docs/remote_inference_blueprints) ## Required connector setup for batch predict ```json @@ -25,7 +25,7 @@ POST /_plugins/_ml/connectors/_create "protocol": "http", "parameters": { "model": "text-embedding-ada-002", - "input_file_id": "", + "input_file_id": "", "endpoint": "/v1/embeddings" }, "credential": { @@ -96,6 +96,7 @@ POST /_plugins/_ml/models/lyjxwZABNrAVdFa9zrcZ/_batch_predict } ``` {% include copy-curl.html %} +The parameters in the batch_predict request will override those defined in the connector. #### Example response diff --git a/_ml-commons-plugin/api/model-apis/index.md b/_ml-commons-plugin/api/model-apis/index.md index f0e0d357b3..431b885f52 100644 --- a/_ml-commons-plugin/api/model-apis/index.md +++ b/_ml-commons-plugin/api/model-apis/index.md @@ -19,7 +19,7 @@ ML Commons supports the following model-level APIs: - [Undeploy model]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/undeploy-model/) - [Delete model]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/delete-model/) - [Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/train-predict/predict/) (invokes a model) -- [Batch Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/batch-predict/) (offline batch inference for a model) +- [Batch Predict]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/batch-predict/) (experimental) ## Model access control considerations