Default semantic_text fields to ELSER on EIS when available #134708
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| pr: 134708 | ||
| summary: Default `semantic_text` fields to ELSER on EIS when available | ||
| area: Mapping | ||
| type: enhancement | ||
| issues: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. | ||
| * Licensed under the Elastic License 2.0; you may not use this file except | ||
| * in compliance with the Elastic License 2.0. | ||
| */ | ||
| package org.elasticsearch.xpack.inference; | ||
|
|
||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.common.xcontent.support.XContentMapValues; | ||
| import org.junit.Before; | ||
| import org.junit.BeforeClass; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Map; | ||
|
|
||
| import static org.elasticsearch.xpack.inference.mapper.SemanticTextFieldMapper.DEFAULT_EIS_ELSER_INFERENCE_ID; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
|
|
||
| /** | ||
| * End-to-end test that verifies semantic_text fields automatically default to ELSER on EIS | ||
| * when available and no inference_id is explicitly provided. | ||
| */ | ||
| public class SemanticTextEISDefaultIT extends BaseMockEISAuthServerTest { | ||
|
|
||
| @Before | ||
| public void setUp() throws Exception { | ||
| super.setUp(); | ||
| // Ensure the mock EIS server has an authorized response ready before each test | ||
| mockEISServer.enqueueAuthorizeAllModelsResponse(); | ||
| } | ||
|
|
||
| /** | ||
| * This is done before the class because I've run into issues where another class that extends {@link BaseMockEISAuthServerTest} | ||
| * results in an authorization response not being queued up for the new Elasticsearch Node in time. When the node starts up, it | ||
| * retrieves authorization. If the request isn't queued up when that happens the tests will fail. From my testing locally it seems | ||
| * like the base class's static functionality to queue a response is only done once and not for each subclass. | ||
| * | ||
| * My understanding is that the @Before will be run after the node starts up and wouldn't be sufficient to handle | ||
| * this scenario. That is why this needs to be @BeforeClass. | ||
| */ | ||
|
There was a problem hiding this comment. I was initially unsure about keeping this comment due to potential redundancy, but decided to leave it as-is since the added verbosity makes it more explanatory. |
||
| @BeforeClass | ||
| public static void init() { | ||
| // Ensure the mock EIS server has an authorized response ready | ||
| mockEISServer.enqueueAuthorizeAllModelsResponse(); | ||
| } | ||
|
|
||
| public void testDefaultInferenceIdForSemanticText() throws IOException { | ||
| String indexName = "semantic-index"; | ||
| String mapping = """ | ||
| { | ||
| "properties": { | ||
| "semantic_text_field": { | ||
| "type": "semantic_text" | ||
| } | ||
| } | ||
| } | ||
| """; | ||
| Settings settings = Settings.builder().build(); | ||
| createIndex(indexName, settings, mapping); | ||
|
|
||
| Map<String, Object> mappingAsMap = getIndexMappingAsMap(indexName); | ||
| String populatedInferenceId = (String) XContentMapValues.extractValue("properties.semantic_text_field.inference_id", mappingAsMap); | ||
|
|
||
| assertThat( | ||
| "semantic_text field should default to ELSER on EIS when available", | ||
| populatedInferenceId, | ||
| equalTo(DEFAULT_EIS_ELSER_INFERENCE_ID) | ||
| ); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on my understanding of the conversation in #134708 (comment) (and the linked references), I think we only need the
@BeforeClassannotated method. However, this additional@Beforemethod will be harmless at worst, so nothing to block over. As @ioanatia said earlier, we can sync with the ML team and clean this up later.