Skip to content

Restore TextSimilarityRankBuilder XContent output #124564

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 11, 2025
Merged

Restore TextSimilarityRankBuilder XContent output #124564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e770789
Restore TextSimilarityRankBuilder XContent output
thecoop Mar 11, 2025
ee8152e
Update docs/changelog/124564.yaml
thecoop Mar 11, 2025
8e3bb9c
Add new field
thecoop Mar 11, 2025
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
5 changes: 5 additions & 0 deletions docs/changelog/124564.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 124564
summary: Restore `TextSimilarityRankBuilder` XContent output
area: Ranking
type: bug
issues: []
18 changes: 17 additions & 1 deletion ...java/org/elasticsearch/xpack/inference/rank/textsimilarity/TextSimilarityRankBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
import java.util.List;
import java.util.Objects;

import static org.elasticsearch.xpack.inference.rank.textsimilarity.TextSimilarityRankRetrieverBuilder.FAILURES_ALLOWED_FIELD;
import static org.elasticsearch.xpack.inference.rank.textsimilarity.TextSimilarityRankRetrieverBuilder.FIELD_FIELD;
import static org.elasticsearch.xpack.inference.rank.textsimilarity.TextSimilarityRankRetrieverBuilder.INFERENCE_ID_FIELD;
import static org.elasticsearch.xpack.inference.rank.textsimilarity.TextSimilarityRankRetrieverBuilder.INFERENCE_TEXT_FIELD;
import static org.elasticsearch.xpack.inference.rank.textsimilarity.TextSimilarityRankRetrieverBuilder.MIN_SCORE_FIELD;

/**
* A {@code RankBuilder} that enables ranking with text similarity model inference. Supports parameters for configuring the inference call.
*/
Expand Down Expand Up @@ -103,7 +109,17 @@ public void doWriteTo(StreamOutput out) throws IOException {

@Override
public void doXContent(XContentBuilder builder, Params params) throws IOException {
throw new UnsupportedOperationException("This should not be XContent serialized");
// this object is not parsed, but it sometimes needs to be output as xcontent
// rankWindowSize serialization is handled by the parent class RankBuilder
builder.field(INFERENCE_ID_FIELD.getPreferredName(), inferenceId);
builder.field(INFERENCE_TEXT_FIELD.getPreferredName(), inferenceText);
builder.field(FIELD_FIELD.getPreferredName(), field);
if (minScore != null) {
builder.field(MIN_SCORE_FIELD.getPreferredName(), minScore);
}
if (failuresAllowed) {
builder.field(FAILURES_ALLOWED_FIELD.getPreferredName(), true);
}
}

@Override
Expand Down