Skip to content

Commit

Permalink
[DOCS] Addresses feedback.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Apr 15, 2024
1 parent 371bb93 commit 9e0dd94
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions docs/reference/inference/put-inference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ 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:
* `cohere`: specify the `text_embedding` or the `rerank `task type to use the
* `cohere`: specify the `text_embedding` or the `rerank` task type to use the
Cohere service.
* `elser`: specify the `sparse_embedding` task type to use the ELSER service.
* `hugging_face`: specify the `text_embedding` task type to use the Hugging Face
Expand Down Expand Up @@ -113,11 +113,8 @@ Valid values are:
`model_id`::
(Optional, string)
The name of the model to use for the {infer} task.
Available values for `rerank`:
* `rerank-english-v3.0`,
* `rerank-multilingual-v3.0`,
* `rerank-english-v2.0`,
* `rerank-multilingual-v2.0`.
To review the availble `rerank` models, refer to the
https://docs.cohere.com/reference/rerank-1[Cohere docs].
To review the available `text_embedding` models, refer to the
https://docs.cohere.com/reference/embed[Cohere docs]. The default value for
Expand Down Expand Up @@ -234,11 +231,8 @@ used for abuse detection.
=====
`return_documents`::
(Optional, boolean)
For `cohere` service only. Specifies whether to return results with the doc
text. If `false`, the API returns a list of `index` and `relevance score` value
where `index`` is inferred from the doc list passed into the request. If `ture`,
the API returns an ordered list of `index`, `text` and `relevance score` values
where `index` and `text` refers to the doc list passed into the request.
For `cohere` service only. Specify whether to return doc text within the
results.
`top_n`::
(Optional, integer)
Expand Down Expand Up @@ -326,6 +320,9 @@ PUT _inference/rerank/cohere-rerank
------------------------------------------------------------
// TEST[skip:TBD]

For more examples, also review the
https://docs.cohere.com/docs/elasticsearch-and-cohere#rerank-search-results-with-cohere-and-elasticsearch[Cohere documentation].


[discrete]
[[inference-example-e5]]
Expand Down

0 comments on commit 9e0dd94

Please sign in to comment.