Learn what parameters you can set for JinaRanker
YAML Init Parameters
These are the parameters you can pass to this component in the pipeline YAML configuration:
Parameter | Type | Possible values | Description |
---|---|---|---|
model | String | Default: jina-reranker-v1-base-en | The name of the Jina model to use. Check the list of available models on Jina's website. Required. |
api_key | Secret | Default: Secret = Secret.from_env_var("JINA_API_KEY") | The Jina API key. It can be explicitly provided or automatically read from the environment variable JINA_API_KEY (recommended). Required. |
top_k | Integer | Default: None | The maximum number of documents to return per query. If None , all documents are returned.Optional. |
score_threshold | Float | Default: None | If provided, only returns documents with a score above this threshold. Optional. |
REST API Runtime Parameters
There are no runtime parameters you can pass to this component when making a request to the Search REST API endpoint.