Skip to content

add EIS rerank default inference endpoint #129681

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 10 commits into from
Jun 23, 2025
Merged

add EIS rerank default inference endpoint #129681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
59e2c38
add EIS rerank default inference endpoint
brendan-jugan-elastic Jun 19, 2025
ecf6908
[CI] Auto commit changes from spotless
elasticsearchmachine Jun 19, 2025
ef407a7
Merge branch 'main' into eis-rerank-default-inference-endpoint
brendan-jugan-elastic Jun 20, 2025
121c68e
fix integ tests
brendan-jugan-elastic Jun 20, 2025
e3e68d3
Merge branch 'main' into eis-rerank-default-inference-endpoint
brendan-jugan-elastic Jun 20, 2025
c8383e9
update mock EIS authorization response
brendan-jugan-elastic Jun 22, 2025
5a96d79
Merge branch 'main' into eis-rerank-default-inference-endpoint
brendan-jugan-elastic Jun 22, 2025
baee17a
fix rerank service test
brendan-jugan-elastic Jun 22, 2025
bb027b7
Merge branch 'main' into eis-rerank-default-inference-endpoint
brendan-jugan-elastic Jun 22, 2025
5cec066
Merge branch 'main' into eis-rerank-default-inference-endpoint
brendan-jugan-elastic Jun 23, 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
3 changes: 2 additions & 1 deletion ...va/org/elasticsearch/xpack/inference/InferenceGetModelsWithElasticInferenceServiceIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public void testGetDefaultEndpoints() throws IOException {
var allModels = getAllModels();
var chatCompletionModels = getModels("_all", TaskType.CHAT_COMPLETION);

assertThat(allModels, hasSize(5));
assertThat(allModels, hasSize(6));
assertThat(chatCompletionModels, hasSize(1));

for (var model : chatCompletionModels) {
Expand All @@ -42,6 +42,7 @@ public void testGetDefaultEndpoints() throws IOException {

assertInferenceIdTaskType(allModels, ".rainbow-sprinkles-elastic", TaskType.CHAT_COMPLETION);
assertInferenceIdTaskType(allModels, ".elser-v2-elastic", TaskType.SPARSE_EMBEDDING);
assertInferenceIdTaskType(allModels, ".rerank-v1-elastic", TaskType.RERANK);
}

private static void assertInferenceIdTaskType(List<Map<String, Object>> models, String inferenceId, TaskType taskType) {
Expand Down
5 changes: 3 additions & 2 deletions ...tests/src/javaRestTest/java/org/elasticsearch/xpack/inference/InferenceGetServicesIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public void testGetServicesWithTextEmbeddingTaskType() throws IOException {

public void testGetServicesWithRerankTaskType() throws IOException {
List<Object> services = getServices(TaskType.RERANK);
assertThat(services.size(), equalTo(9));
assertThat(services.size(), equalTo(10));

var providers = providers(services);

Expand All @@ -127,7 +127,8 @@ public void testGetServicesWithRerankTaskType() throws IOException {
"jinaai",
"test_reranking_service",
"voyageai",
"hugging_face"
"hugging_face",
"elastic"
).toArray()
)
);
Expand Down
4 changes: 4 additions & 0 deletions ...ava/org/elasticsearch/xpack/inference/MockElasticInferenceServiceAuthorizationServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ public void enqueueAuthorizeAllModelsResponse() {
{
"model_name": "elser-v2",
"task_types": ["embed/text/sparse"]
},
{
"model_name": "rerank-v1",
"task_types": ["rerank/text/text-similarity"]
}
]
}
Expand Down
26 changes: 24 additions & 2 deletions ...java/org/elasticsearch/xpack/inference/integration/InferenceRevokeDefaultEndpointsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,10 @@ public void testRemoves_DefaultChatCompletion_V1_WhenAuthorizationDoesNotReturnA
{
"model_name": "elser-v2",
"task_types": ["embed/text/sparse"]
},
{
"model_name": "rerank-v1",
"task_types": ["rerank/text/text-similarity"]
}
]
}
Expand All @@ -221,16 +225,25 @@ public void testRemoves_DefaultChatCompletion_V1_WhenAuthorizationDoesNotReturnA
".rainbow-sprinkles-elastic",
MinimalServiceSettings.chatCompletion(ElasticInferenceService.NAME),
service
),
new InferenceService.DefaultConfigId(
".rerank-v1-elastic",
MinimalServiceSettings.rerank(ElasticInferenceService.NAME),
service
)
)
)
);
assertThat(service.supportedTaskTypes(), is(EnumSet.of(TaskType.CHAT_COMPLETION, TaskType.SPARSE_EMBEDDING)));
assertThat(
service.supportedTaskTypes(),
is(EnumSet.of(TaskType.CHAT_COMPLETION, TaskType.SPARSE_EMBEDDING, TaskType.RERANK))
);

PlainActionFuture<List<Model>> listener = new PlainActionFuture<>();
service.defaultConfigs(listener);
assertThat(listener.actionGet(TIMEOUT).get(0).getConfigurations().getInferenceEntityId(), is(".elser-v2-elastic"));
assertThat(listener.actionGet(TIMEOUT).get(1).getConfigurations().getInferenceEntityId(), is(".rainbow-sprinkles-elastic"));
assertThat(listener.actionGet(TIMEOUT).get(2).getConfigurations().getInferenceEntityId(), is(".rerank-v1-elastic"));

var getModelListener = new PlainActionFuture<UnparsedModel>();
// persists the default endpoints
Expand All @@ -248,6 +261,10 @@ public void testRemoves_DefaultChatCompletion_V1_WhenAuthorizationDoesNotReturnA
{
"model_name": "elser-v2",
"task_types": ["embed/text/sparse"]
},
{
"model_name": "rerank-v1",
"task_types": ["rerank/text/text-similarity"]
}
]
}
Expand All @@ -267,11 +284,16 @@ public void testRemoves_DefaultChatCompletion_V1_WhenAuthorizationDoesNotReturnA
".elser-v2-elastic",
MinimalServiceSettings.sparseEmbedding(ElasticInferenceService.NAME),
service
),
new InferenceService.DefaultConfigId(
".rerank-v1-elastic",
MinimalServiceSettings.rerank(ElasticInferenceService.NAME),
service
)
)
)
);
assertThat(service.supportedTaskTypes(), is(EnumSet.of(TaskType.SPARSE_EMBEDDING)));
assertThat(service.supportedTaskTypes(), is(EnumSet.of(TaskType.SPARSE_EMBEDDING, TaskType.RERANK)));

var getModelListener = new PlainActionFuture<UnparsedModel>();
modelRegistry.getModel(".rainbow-sprinkles-elastic", getModelListener);
Expand Down
18 changes: 18 additions & 0 deletions ...main/java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
import org.elasticsearch.xpack.inference.services.elastic.completion.ElasticInferenceServiceCompletionModel;
import org.elasticsearch.xpack.inference.services.elastic.completion.ElasticInferenceServiceCompletionServiceSettings;
import org.elasticsearch.xpack.inference.services.elastic.rerank.ElasticInferenceServiceRerankModel;
import org.elasticsearch.xpack.inference.services.elastic.rerank.ElasticInferenceServiceRerankServiceSettings;
import org.elasticsearch.xpack.inference.services.elastic.sparseembeddings.ElasticInferenceServiceSparseEmbeddingsModel;
import org.elasticsearch.xpack.inference.services.elastic.sparseembeddings.ElasticInferenceServiceSparseEmbeddingsServiceSettings;
import org.elasticsearch.xpack.inference.services.settings.RateLimitSettings;
Expand Down Expand Up @@ -95,6 +96,10 @@ public class ElasticInferenceService extends SenderService {
static final String DEFAULT_ELSER_MODEL_ID_V2 = "elser-v2";
static final String DEFAULT_ELSER_ENDPOINT_ID_V2 = defaultEndpointId(DEFAULT_ELSER_MODEL_ID_V2);

// rerank-v1
static final String DEFAULT_RERANK_MODEL_ID_V1 = "rerank-v1";
static final String DEFAULT_RERANK_ENDPOINT_ID_V1 = defaultEndpointId(DEFAULT_RERANK_MODEL_ID_V1);

/**
* The task types that the {@link InferenceAction.Request} can accept.
*/
Expand Down Expand Up @@ -159,6 +164,19 @@ private static Map<String, DefaultModelConfig> initDefaultEndpoints(
elasticInferenceServiceComponents
),
MinimalServiceSettings.sparseEmbedding(NAME)
),
DEFAULT_RERANK_MODEL_ID_V1,
new DefaultModelConfig(
new ElasticInferenceServiceRerankModel(
DEFAULT_RERANK_ENDPOINT_ID_V1,
TaskType.RERANK,
NAME,
new ElasticInferenceServiceRerankServiceSettings(DEFAULT_RERANK_MODEL_ID_V1, null),
EmptyTaskSettings.INSTANCE,
EmptySecretSettings.INSTANCE,
elasticInferenceServiceComponents
),
MinimalServiceSettings.rerank(NAME)
)
);
}
Expand Down
2 changes: 1 addition & 1 deletion ...ticsearch/xpack/inference/services/elastic/rerank/ElasticInferenceServiceRerankModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public URI uri() {
private URI createUri() throws ElasticsearchStatusException {
try {
// TODO, consider transforming the base URL into a URI for better error handling.
return new URI(elasticInferenceServiceComponents().elasticInferenceServiceUrl() + "/api/v1/rerank");
return new URI(elasticInferenceServiceComponents().elasticInferenceServiceUrl() + "/api/v1/rerank/text/text-similarity");
} catch (URISyntaxException e) {
throw new ElasticsearchStatusException(
"Failed to create URI for service ["
Expand Down
4 changes: 3 additions & 1 deletion ...ference/services/elastic/response/ElasticInferenceServiceAuthorizationResponseEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ public class ElasticInferenceServiceAuthorizationResponseEntity implements Infer
"embed/text/sparse",
TaskType.SPARSE_EMBEDDING,
"chat",
TaskType.CHAT_COMPLETION
TaskType.CHAT_COMPLETION,
"rerank/text/text-similarity",
TaskType.RERANK
);

@SuppressWarnings("unchecked")
Expand Down
15 changes: 13 additions & 2 deletions ...java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceServiceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1294,6 +1294,10 @@ public void testDefaultConfigs_Returns_DefaultEndpoints_WhenTaskTypeIsCorrect()
{
"model_name": "elser-v2",
"task_types": ["embed/text/sparse"]
},
{
"model_name": "rerank-v1",
"task_types": ["rerank/text/text-similarity"]
}
]
}
Expand All @@ -1319,18 +1323,25 @@ public void testDefaultConfigs_Returns_DefaultEndpoints_WhenTaskTypeIsCorrect()
".rainbow-sprinkles-elastic",
MinimalServiceSettings.chatCompletion(ElasticInferenceService.NAME),
service
),
new InferenceService.DefaultConfigId(
".rerank-v1-elastic",
MinimalServiceSettings.rerank(ElasticInferenceService.NAME),
service
)
)
)
);
assertThat(service.supportedTaskTypes(), is(EnumSet.of(TaskType.CHAT_COMPLETION, TaskType.SPARSE_EMBEDDING)));
assertThat(service.supportedTaskTypes(), is(EnumSet.of(TaskType.CHAT_COMPLETION, TaskType.SPARSE_EMBEDDING, TaskType.RERANK)));

PlainActionFuture<List<Model>> listener = new PlainActionFuture<>();
service.defaultConfigs(listener);
var models = listener.actionGet(TIMEOUT);
assertThat(models.size(), is(2));
assertThat(models.size(), is(3));
assertThat(models.get(0).getConfigurations().getInferenceEntityId(), is(".elser-v2-elastic"));
assertThat(models.get(1).getConfigurations().getInferenceEntityId(), is(".rainbow-sprinkles-elastic"));
assertThat(models.get(2).getConfigurations().getInferenceEntityId(), is(".rerank-v1-elastic"));

}
}

Expand Down