Skip to content

Commit

Permalink
[DOCS] Add note about ML model 502 timeout when using `Create inferen…
Browse files Browse the repository at this point in the history
…ce API` (#110835) (#110865)

* [DOCS] Add note about ml model 502 timeout

* Add note to API ref
  • Loading branch information
leemthompo authored Jul 15, 2024
1 parent 223647f commit 10397de
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
10 changes: 8 additions & 2 deletions docs/reference/inference/put-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
For built-in models and models uploaded through Eland, the {infer} APIs offer an alternative way to use and manage trained models.
However, if you do not plan to use the {infer} APIs to use these models or if you want to use non-NLP models, use the <<ml-df-trained-models-apis>>.


[discrete]
[[put-inference-api-request]]
==== {api-request-title}
Expand All @@ -25,7 +24,6 @@ However, if you do not plan to use the {infer} APIs to use these models or if yo
* Requires the `manage_inference` <<privileges-list-cluster,cluster privilege>>
(the built-in `inference_admin` role grants this privilege)


[discrete]
[[put-inference-api-desc]]
==== {api-description-title}
Expand All @@ -45,3 +43,11 @@ The following services are available through the {infer} API, click the links to
* <<infer-service-hugging-face,Hugging Face>>
* <<infer-service-mistral,Mistral>>
* <<infer-service-openai,OpenAI>>

[NOTE]
====
You might see a 502 bad gateway error in the response when using the {kib} Console.
This error usually just reflects a timeout, while the model downloads in the background.
You can check the download progress in the {ml-app} UI.
If using the Python client, you can set the `timeout` parameter to a higher value.
====
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ This tutorial uses the <<inference-example-elser,`elser` service>> for demonstra
To use the `semantic_text` field type, you must have an {infer} endpoint deployed in
your cluster using the <<put-inference-api>>.


[discrete]
[[semantic-text-infer-endpoint]]
==== Create the {infer} endpoint
Expand All @@ -48,6 +47,13 @@ be used and ELSER creates sparse vectors. The `inference_id` is
`my-elser-endpoint`.
<2> The `elser` service is used in this example.

[NOTE]
====
You might see a 502 bad gateway error in the response when using the {kib} Console.
This error usually just reflects a timeout, while the model downloads in the background.
You can check the download progress in the {ml-app} UI.
If using the Python client, you can set the `timeout` parameter to a higher value.
====

[discrete]
[[semantic-text-index-mapping]]
Expand Down

0 comments on commit 10397de

Please sign in to comment.