yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-12-30 08:37:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync Haystack API reference on Docusaurus (#10271)

Browse Source 
Co-authored-by: sjrl <10526848+sjrl@users.noreply.github.com>
This commit is contained in:
Haystack Bot 2025-12-19 10:14:54 +01:00 committed by GitHub
parent 923e014c44
commit cef856486b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs-website/reference/haystack-api/rankers_api.md
View File

@ -813,8 +813,12 @@ Creates an instance of SentenceTransformersSimilarityRanker.
- `top_k`: The maximum number of documents to return per query.
- `query_prefix`: A string to add at the beginning of the query text before ranking.
Use it to prepend the text with an instruction, as required by reranking models like `bge`.
- `query_suffix`: A string to add at the end of the query text before ranking.
Use it to append the text with an instruction, as required by reranking models like `qwen`.
- `document_prefix`: A string to add at the beginning of each document before ranking. You can use it to prepend the document
with an instruction, as required by embedding models like `bge`.
- `document_suffix`: A string to add at the end of each document before ranking. You can use it to append the document
with an instruction, as required by embedding models like `qwen`.
- `meta_fields_to_embed`: List of metadata fields to embed with the document.
- `embedding_separator`: Separator to concatenate metadata fields to the document.
- `scale_score`: If `True`, scales the raw logit predictions using a Sigmoid activation function.