Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Payload Score Parser: expand documentation's pointing to Lucene javadocs #2693

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
import org.apache.solr.util.PayloadUtils;

/**
* Creates a PayloadScoreQuery wrapping a SpanQuery created from the input value, applying text
* analysis and constructing SpanTermQuery or SpanNearQuery based on number of terms. <br>
* Creates a {@link PayloadScoreQuery} wrapping a SpanQuery created from the input value, applying
* text analysis and constructing SpanTermQuery or SpanNearQuery based on number of terms. <br>
* Other parameters: <br>
* <code>f</code>, the field (required) <br>
* <code>func</code>, payload function (min, max, or average; required) <br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -951,8 +951,8 @@ Payloads can be encoded on terms using either the `DelimitedPayloadTokenFilter`

=== Payload Score Parser

`PayloadScoreQParser` incorporates each matching term's numeric (integer or float) payloads into the scores.
The main query is parsed from the field type's query analysis into a `SpanQuery` based on the value of the `operator` parameter below.
Comment on lines -954 to -955
Copy link
Contributor Author

@cpoerschke cpoerschke Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`PayloadScoreQParser` incorporates each matching term's numeric (integer or float) payloads into the scores via a {lucene-javadocs}/queries/org/apache/lucene/queries/payloads/PayloadScoreQuery.html[PayloadScoreQuery] that is wrapping a {lucene-javadocs}/queries/org/apache/lucene/queries/spans/SpanQuery.html[SpanQuery].
The main query is parsed from the field type's query analysis into the `SpanQuery` based on the value of the `operator` parameter below.

This parser accepts the following parameters:

Expand Down
Loading