Skip to content

Commit e3edb22

Browse files
[DOCS] Expands inference API docs (#104047) (#104136)
Co-authored-by: David Kyle <[email protected]>
1 parent 2c44f91 commit e3edb22

File tree

5 files changed

+33
-2
lines changed

5 files changed

+33
-2
lines changed

docs/reference/inference/delete-inference.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ experimental[]
66

77
Deletes an {infer} model deployment.
88

9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
10+
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
11+
can use on an ML node with custom {ml} models. If you want to train and use your
12+
own model, use the <<ml-df-trained-models-apis>>.
13+
914

1015
[discrete]
1116
[[delete-inference-api-request]]

docs/reference/inference/get-inference.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ experimental[]
66

77
Retrieves {infer} model information.
88

9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
10+
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
11+
can use on an ML node with custom {ml} models. If you want to train and use your
12+
own model, use the <<ml-df-trained-models-apis>>.
13+
14+
915
[discrete]
1016
[[get-inference-api-request]]
1117
==== {api-request-title}

docs/reference/inference/inference-apis.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
experimental[]
66

7+
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
8+
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
9+
can use on an ML node with custom {ml} models. If you want to train and use your
10+
own model, use the <<ml-df-trained-models-apis>>.
11+
712
You can use the following APIs to manage {infer} models and perform {infer}:
813

914
* <<delete-inference-api>>

docs/reference/inference/post-inference.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ experimental[]
66

77
Performs an inference task on an input text by using an {infer} model.
88

9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
10+
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
11+
can use on an ML node with custom {ml} models. If you want to train and use your
12+
own model, use the <<ml-df-trained-models-apis>>.
13+
914

1015
[discrete]
1116
[[post-inference-api-request]]

docs/reference/inference/put-inference.asciidoc

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ experimental[]
66

77
Creates a model to perform an {infer} task.
88

9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
10+
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
11+
can use on an ML node with custom {ml} models. If you want to train and use your
12+
own model, use the <<ml-df-trained-models-apis>>.
13+
914

1015
[discrete]
1116
[[put-inference-api-request]]
@@ -27,6 +32,10 @@ Creates a model to perform an {infer} task.
2732
The create {infer} API enables you to create and configure an {infer} model to
2833
perform a specific {infer} task.
2934

35+
The following services are available through the {infer} API:
36+
* ELSER
37+
* OpenAI
38+
* Hugging Face
3039

3140
[discrete]
3241
[[put-inference-api-path-params]]
@@ -52,8 +61,9 @@ The type of the {infer} task that the model will perform. Available task types:
5261
(Required, string)
5362
The type of service supported for the specified task type.
5463
Available services:
55-
* `elser`,
56-
* `openai`.
64+
* `elser`: specify the `sparse_embedding` task type to use the ELSER service.
65+
* `openai`: specify the `text_embedding` task type to use the OpenAI service.
66+
* `hugging_face`: specify the `text_embedding` task type to use the Hugging Face service.
5767

5868
`service_settings`::
5969
(Required, object)

0 commit comments

Comments
 (0)