[DOCS] Expands top_n parameter description in the PUT inference API docs (#111446)

Co-authored-by: Adam Demjen <demjened@gmail.com>
This commit is contained in:
István Zoltán Szabó 2024-07-30 17:32:14 +02:00 committed by GitHub
parent ec845b7fcf
commit 845dc6f252
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -131,6 +131,7 @@ Specify whether to return doc text within the results.
`top_n`:: `top_n`::
(Optional, integer) (Optional, integer)
The number of most relevant documents to return, defaults to the number of the documents. The number of most relevant documents to return, defaults to the number of the documents.
If this {infer} endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query.
===== =====
+ +
.`task_settings` for the `text_embedding` task type .`task_settings` for the `text_embedding` task type