Skip to content

Commit a0ec31e

Browse files
szabosteveszabosteve
authored
[DOCS] Resolves conflict. (#107102)
1 parent ee1acff commit a0ec31e

File tree

5 files changed

+42
-31
lines changed

5 files changed

+42
-31
lines changed

‎docs/reference/inference/delete-inference.asciidoc‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44

55
experimental[]
66

7-
Deletes an {infer} model deployment.
8-
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>>.
7+
Deletes an {infer} endpoint.
8+
9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
10+
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
11+
Hugging Face. For built-in models and models uploaded though Eland, the {infer}
12+
APIs offer an alternative way to use and manage trained models. However, if you
13+
do not plan to use the {infer} APIs to use these models or if you want to use
14+
non-NLP models, use the <<ml-df-trained-models-apis>>.
1315

1416

1517
[discrete]

‎docs/reference/inference/get-inference.asciidoc‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44

55
experimental[]
66

7-
Retrieves {infer} model information.
7+
Retrieves {infer} endpoint 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>>.
9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
10+
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
11+
Hugging Face. For built-in models and models uploaded though Eland, the {infer}
12+
APIs offer an alternative way to use and manage trained models. However, if you
13+
do not plan to use the {infer} APIs to use these models or if you want to use
14+
non-NLP models, use the <<ml-df-trained-models-apis>>.
1315

1416

1517
[discrete]
@@ -36,10 +38,10 @@ own model, use the <<ml-df-trained-models-apis>>.
3638

3739
You can get information in a single API request for:
3840

39-
* a single {infer} model by providing the task type and the model ID,
40-
* all of the {infer} models for a certain task type by providing the task type
41-
and a wildcard expression,
42-
* all of the {infer} models by using a wildcard expression.
41+
* a single {infer} endpoint by providing the task type and the {infer} ID,
42+
* all of the {infer} endpoints for a certain task type by providing the task
43+
type and a wildcard expression,
44+
* all of the {infer} endpoints by using a wildcard expression.
4345

4446

4547
[discrete]

‎docs/reference/inference/inference-apis.asciidoc‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@
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>>.
7+
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
8+
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
9+
Hugging Face. For built-in models and models uploaded though Eland, the {infer}
10+
APIs offer an alternative way to use and manage trained models. However, if you
11+
do not plan to use the {infer} APIs to use these models or if you want to use
12+
non-NLP models, use the <<ml-df-trained-models-apis>>.
1113

12-
You can use the following APIs to manage {infer} models and perform {infer}:
14+
The {infer} APIs enable you to create {infer} endpoints and use {ml} models of
15+
different providers - such as Cohere, OpenAI, or HuggingFace - as a service. Use
16+
the following APIs to manage {infer} models and perform {infer}:
1317

1418
* <<delete-inference-api>>
1519
* <<get-inference-api>>

‎docs/reference/inference/post-inference.asciidoc‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44

55
experimental[]
66

7-
Performs an inference task on an input text by using an {infer} model.
7+
Performs an inference task on an input text by using an {infer} endpoint.
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>>.
9+
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
10+
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
11+
Hugging Face. For built-in models and models uploaded though Eland, the {infer}
12+
APIs offer an alternative way to use and manage trained models. However, if you
13+
do not plan to use the {infer} APIs to use these models or if you want to use
14+
non-NLP models, use the <<ml-df-trained-models-apis>>.
1315

1416

1517
[discrete]
@@ -33,9 +35,10 @@ own model, use the <<ml-df-trained-models-apis>>.
3335
==== {api-description-title}
3436

3537
The perform {infer} API enables you to use {ml} models to perform specific tasks
36-
on data that you provide as an input. The API returns a response with the
37-
resutls of the tasks. The {infer} model you use can perform one specific task
38-
that has been defined when the model was created with the <<put-inference-api>>.
38+
on data that you provide as an input. The API returns a response with the
39+
results of the tasks. The {infer} endpoint you use can perform one specific task
40+
that has been defined when the endpoint was created with the
41+
<<put-inference-api>>.
3942

4043

4144
[discrete]

‎docs/reference/inference/put-inference.asciidoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
experimental[]
66

7-
Creates a model to perform an {infer} task.
7+
Creates an {infer} endpoint to perform an {infer} task.
88

99
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
1010
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
@@ -32,8 +32,8 @@ or if you want to use non-NLP models, use the <<ml-df-trained-models-apis>>.
3232
[[put-inference-api-desc]]
3333
==== {api-description-title}
3434

35-
The create {infer} API enables you to create and configure a {ml} model to
36-
perform a specific {infer} task.
35+
The create {infer} API enables you to create an {infer} endpoint and configure a
36+
{ml} model to perform a specific {infer} task.
3737

3838
The following services are available through the {infer} API:
3939

0 commit comments

Comments
 (0)