[DOCS] Expands inference API docs (elastic#104047)

Co-authored-by: David Kyle <[email protected]>
szabosteve · Jan 9, 2024 · 0575840 · 0575840
1 parent 2c44f91
commit 0575840
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 2 deletions.
diff --git a/docs/reference/inference/delete-inference.asciidoc b/docs/reference/inference/delete-inference.asciidoc
@@ -6,6 +6,11 @@ experimental[]
 
 Deletes an {infer} model deployment.
 
+IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER, 
+OpenAI, or Hugging Face, in your cluster. This is not the same feature that you 
+can use on an ML node with custom {ml} models. If you want to train and use your 
+own model, use the <<ml-df-trained-models-apis>>.
+
 
 [discrete]
 [[delete-inference-api-request]]

diff --git a/docs/reference/inference/get-inference.asciidoc b/docs/reference/inference/get-inference.asciidoc
@@ -6,6 +6,12 @@ experimental[]
 
 Retrieves {infer} model information.
 
+IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER, 
+OpenAI, or Hugging Face, in your cluster. This is not the same feature that you 
+can use on an ML node with custom {ml} models. If you want to train and use your 
+own model, use the <<ml-df-trained-models-apis>>.
+
+
 [discrete]
 [[get-inference-api-request]]
 ==== {api-request-title}

diff --git a/docs/reference/inference/inference-apis.asciidoc b/docs/reference/inference/inference-apis.asciidoc
@@ -4,6 +4,11 @@
 
 experimental[]
 
+IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER, 
+OpenAI, or Hugging Face, in your cluster. This is not the same feature that you 
+can use on an ML node with custom {ml} models. If you want to train and use your 
+own model, use the <<ml-df-trained-models-apis>>.
+
 You can use the following APIs to manage {infer} models and perform {infer}:
 
 * <<delete-inference-api>>

diff --git a/docs/reference/inference/post-inference.asciidoc b/docs/reference/inference/post-inference.asciidoc
@@ -6,6 +6,11 @@ experimental[]
 
 Performs an inference task on an input text by using an {infer} model.
 
+IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER, 
+OpenAI, or Hugging Face, in your cluster. This is not the same feature that you 
+can use on an ML node with custom {ml} models. If you want to train and use your 
+own model, use the <<ml-df-trained-models-apis>>.
+
 
 [discrete]
 [[post-inference-api-request]]

diff --git a/docs/reference/inference/put-inference.asciidoc b/docs/reference/inference/put-inference.asciidoc
@@ -6,6 +6,11 @@ experimental[]
 
 Creates a model to perform an {infer} task.
 
+IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER, 
+OpenAI, or Hugging Face, in your cluster. This is not the same feature that you 
+can use on an ML node with custom {ml} models. If you want to train and use your 
+own model, use the <<ml-df-trained-models-apis>>.
+
 
 [discrete]
 [[put-inference-api-request]]
@@ -27,6 +32,10 @@ Creates a model to perform an {infer} task.
 The create {infer} API enables you to create and configure an {infer} model to
 perform a specific {infer} task.
 
+The following services are available through the {infer} API:
+* ELSER
+* OpenAI
+* Hugging Face
 
 [discrete]
 [[put-inference-api-path-params]]
@@ -52,8 +61,9 @@ The type of the {infer} task that the model will perform. Available task types:
 (Required, string)
 The type of service supported for the specified task type.
 Available services:
-* `elser`,
-* `openai`.
+* `elser`: specify the `sparse_embedding` task type to use the ELSER service.
+* `openai`: specify the `text_embedding` task type to use the OpenAI service.
+* `hugging_face`: specify the `text_embedding` task type to use the Hugging Face service.
 
 `service_settings`::
 (Required, object)