Skip to content

Commit

Permalink
Add note to API ref
Browse files Browse the repository at this point in the history
  • Loading branch information
leemthompo committed Jul 15, 2024
1 parent fab329a commit 3a3c0a6
Showing 1 changed file with 8 additions and 2 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.
====

0 comments on commit 3a3c0a6

Please sign in to comment.