JoinDocuments Parameters

Check the init and runtime parameters you can specify for the JoinDocuments node.

YAML Init Parameters

These are the parameters you can specify in pipeline YAML:

Parameter	Type	Possible Values	Description
`join_mode`	String	`concatenate` (default) `merge` `reciprocal_rank_fusion`	Specifies how the documents should be combined. Possible options: - `concatenate` - Combines documents from multiple retrievers. - `merge` - Aggregates scores of individual documents. - `reciprocal_rank_fusion` - Applies rank-based scoring. Mandatory.
`weights`	List	Default: `none`	A list of weights for adjusting document scores when using the `merge` join mode. The number of entries in the list must be equal to the number of input nodes (retrievers). By default, each retriever score gets equal weight. This parameter is not compatible with the `concatenate` join mode. Optional.
`top_k_join`	Integer	Default: `none`	Limits the number of documents that JoinDocuments returns. Optional.
`sort_by_score`	Boolean Mandatory	`True` (default) `False`	Sorts the incoming documents should by their score. If all your documents have `score` values, set this to `True`. Otherwise, set this to `False`.

REST API Runtime Parameters

These are the runtime parameters you can pass in the body of the request to the Search endpoint:

Parameter	Type	Possible Values	Description
`top_k_join`	Integer	Default: `none`	The maximum number of documents returned. Optional.