Skip to content

Commit

Permalink
[DOCS] Resolves conflict. (#107102)
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Apr 5, 2024
1 parent ee1acff commit a0ec31e
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 31 deletions.
14 changes: 8 additions & 6 deletions docs/reference/inference/delete-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

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>>.
Deletes an {infer} endpoint.

IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
Hugging Face. For built-in models and models uploaded though 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]
Expand Down
20 changes: 11 additions & 9 deletions docs/reference/inference/get-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

experimental[]

Retrieves {infer} model information.
Retrieves {infer} endpoint 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>>.
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
Hugging Face. For built-in models and models uploaded though 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]
Expand All @@ -36,10 +38,10 @@ own model, use the <<ml-df-trained-models-apis>>.

You can get information in a single API request for:

* a single {infer} model by providing the task type and the model ID,
* all of the {infer} models for a certain task type by providing the task type
and a wildcard expression,
* all of the {infer} models by using a wildcard expression.
* a single {infer} endpoint by providing the task type and the {infer} ID,
* all of the {infer} endpoints for a certain task type by providing the task
type and a wildcard expression,
* all of the {infer} endpoints by using a wildcard expression.


[discrete]
Expand Down
14 changes: 9 additions & 5 deletions docs/reference/inference/inference-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@

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>>.
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
Hugging Face. For built-in models and models uploaded though 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>>.

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

* <<delete-inference-api>>
* <<get-inference-api>>
Expand Down
19 changes: 11 additions & 8 deletions docs/reference/inference/post-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

experimental[]

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

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>>.
IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in
{ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, or
Hugging Face. For built-in models and models uploaded though 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]
Expand All @@ -33,9 +35,10 @@ own model, use the <<ml-df-trained-models-apis>>.
==== {api-description-title}

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


[discrete]
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/inference/put-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

experimental[]

Creates a model to perform an {infer} task.
Creates an {infer} endpoint to perform an {infer} task.

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

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

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

Expand Down

0 comments on commit a0ec31e

Please sign in to comment.