Skip to content

[ML] Refactor OpenAI request managers #124144

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

Merged
merged 3 commits into from
Mar 6, 2025
Merged
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 @@ -10,9 +10,18 @@
import org.elasticsearch.xpack.inference.external.action.ExecutableAction;
import org.elasticsearch.xpack.inference.external.action.SenderExecutableAction;
import org.elasticsearch.xpack.inference.external.action.SingleInputSenderExecutableAction;
import org.elasticsearch.xpack.inference.external.http.sender.OpenAiCompletionRequestManager;
import org.elasticsearch.xpack.inference.external.http.sender.OpenAiEmbeddingsRequestManager;
import org.elasticsearch.xpack.inference.external.http.retry.ResponseHandler;
import org.elasticsearch.xpack.inference.external.http.sender.ChatCompletionInput;
import org.elasticsearch.xpack.inference.external.http.sender.GenericRequestManager;
import org.elasticsearch.xpack.inference.external.http.sender.Sender;
import org.elasticsearch.xpack.inference.external.http.sender.TruncatingRequestManager;
import org.elasticsearch.xpack.inference.external.http.sender.UnifiedChatInput;
import org.elasticsearch.xpack.inference.external.openai.OpenAiChatCompletionResponseHandler;
import org.elasticsearch.xpack.inference.external.openai.OpenAiResponseHandler;
import org.elasticsearch.xpack.inference.external.request.openai.OpenAiEmbeddingsRequest;
import org.elasticsearch.xpack.inference.external.request.openai.OpenAiUnifiedChatCompletionRequest;
import org.elasticsearch.xpack.inference.external.response.openai.OpenAiChatCompletionResponseEntity;
import org.elasticsearch.xpack.inference.external.response.openai.OpenAiEmbeddingsResponseEntity;
import org.elasticsearch.xpack.inference.services.ServiceComponents;
import org.elasticsearch.xpack.inference.services.openai.completion.OpenAiChatCompletionModel;
import org.elasticsearch.xpack.inference.services.openai.embeddings.OpenAiEmbeddingsModel;
Expand All @@ -27,6 +36,18 @@
*/
public class OpenAiActionCreator implements OpenAiActionVisitor {
public static final String COMPLETION_ERROR_PREFIX = "OpenAI chat completions";
public static final String USER_ROLE = "user";

static final ResponseHandler COMPLETION_HANDLER = new OpenAiChatCompletionResponseHandler(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This changes are basically to move the logic from the request manager files into here.

"openai completion",
OpenAiChatCompletionResponseEntity::fromResponse
);
public static final ResponseHandler EMBEDDINGS_HANDLER = new OpenAiResponseHandler(
"openai text embedding",
OpenAiEmbeddingsResponseEntity::fromResponse,
false
);

private final Sender sender;
private final ServiceComponents serviceComponents;

Expand All @@ -38,20 +59,30 @@ public OpenAiActionCreator(Sender sender, ServiceComponents serviceComponents) {
@Override
public ExecutableAction create(OpenAiEmbeddingsModel model, Map<String, Object> taskSettings) {
var overriddenModel = OpenAiEmbeddingsModel.of(model, taskSettings);
var requestCreator = OpenAiEmbeddingsRequestManager.of(
var manager = new TruncatingRequestManager(
serviceComponents.threadPool(),
overriddenModel,
serviceComponents.truncator(),
serviceComponents.threadPool()
EMBEDDINGS_HANDLER,
(truncationResult) -> new OpenAiEmbeddingsRequest(serviceComponents.truncator(), truncationResult, overriddenModel),
overriddenModel.getServiceSettings().maxInputTokens()
);

var errorMessage = constructFailedToSendRequestMessage("OpenAI embeddings");
return new SenderExecutableAction(sender, requestCreator, errorMessage);
return new SenderExecutableAction(sender, manager, errorMessage);
}

@Override
public ExecutableAction create(OpenAiChatCompletionModel model, Map<String, Object> taskSettings) {
var overriddenModel = OpenAiChatCompletionModel.of(model, taskSettings);
var requestCreator = OpenAiCompletionRequestManager.of(overriddenModel, serviceComponents.threadPool());
var manager = new GenericRequestManager<>(
serviceComponents.threadPool(),
overriddenModel,
COMPLETION_HANDLER,
(inputs) -> new OpenAiUnifiedChatCompletionRequest(new UnifiedChatInput(inputs, USER_ROLE), overriddenModel),
ChatCompletionInput.class
);

var errorMessage = constructFailedToSendRequestMessage(COMPLETION_ERROR_PREFIX);
return new SingleInputSenderExecutableAction(sender, requestCreator, errorMessage, COMPLETION_ERROR_PREFIX);
return new SingleInputSenderExecutableAction(sender, manager, errorMessage, COMPLETION_ERROR_PREFIX);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
package org.elasticsearch.xpack.inference.external.http.sender;

import org.elasticsearch.threadpool.ThreadPool;
import org.elasticsearch.xpack.inference.services.RateLimitGroupingModel;
import org.elasticsearch.xpack.inference.services.settings.RateLimitSettings;

import java.util.Objects;
Expand All @@ -17,14 +18,31 @@
abstract class BaseRequestManager implements RequestManager {
private final ThreadPool threadPool;
private final String inferenceEntityId;
private final Object rateLimitGroup;
// It's possible that two inference endpoints have the same information defining the group but have different
// rate limits then they should be in different groups otherwise whoever initially created the group will set
// the rate and the other inference endpoint's rate will be ignored
private final EndpointGrouping endpointGrouping;
private final RateLimitSettings rateLimitSettings;

BaseRequestManager(ThreadPool threadPool, String inferenceEntityId, Object rateLimitGroup, RateLimitSettings rateLimitSettings) {
this.threadPool = Objects.requireNonNull(threadPool);
this.inferenceEntityId = Objects.requireNonNull(inferenceEntityId);
this.rateLimitGroup = Objects.requireNonNull(rateLimitGroup);
this.rateLimitSettings = Objects.requireNonNull(rateLimitSettings);

Objects.requireNonNull(rateLimitSettings);
this.endpointGrouping = new EndpointGrouping(Objects.requireNonNull(rateLimitGroup).hashCode(), rateLimitSettings);
this.rateLimitSettings = rateLimitSettings;
}

BaseRequestManager(ThreadPool threadPool, RateLimitGroupingModel rateLimitGroupingModel) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a stopgap. Once all the request managers are refactored the old constructor can be removed.

this.threadPool = Objects.requireNonNull(threadPool);
Objects.requireNonNull(rateLimitGroupingModel);

this.inferenceEntityId = rateLimitGroupingModel.inferenceEntityId();
this.endpointGrouping = new EndpointGrouping(
rateLimitGroupingModel.rateLimitGroupingHash(),
rateLimitGroupingModel.rateLimitSettings()
);
this.rateLimitSettings = rateLimitGroupingModel.rateLimitSettings();
}

protected void execute(Runnable runnable) {
Expand All @@ -38,16 +56,13 @@ public String inferenceEntityId() {

@Override
public Object rateLimitGrouping() {
// It's possible that two inference endpoints have the same information defining the group but have different
// rate limits then they should be in different groups otherwise whoever initially created the group will set
// the rate and the other inference endpoint's rate will be ignored
return new EndpointGrouping(rateLimitGroup, rateLimitSettings);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't need to be recreating the object on each call.

return endpointGrouping;
}

@Override
public RateLimitSettings rateLimitSettings() {
return rateLimitSettings;
}

private record EndpointGrouping(Object group, RateLimitSettings settings) {}
private record EndpointGrouping(int group, RateLimitSettings settings) {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. 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.external.http.sender;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.inference.InferenceServiceResults;
import org.elasticsearch.threadpool.ThreadPool;
import org.elasticsearch.xpack.inference.external.http.retry.RequestSender;
import org.elasticsearch.xpack.inference.external.http.retry.ResponseHandler;
import org.elasticsearch.xpack.inference.external.request.Request;
import org.elasticsearch.xpack.inference.services.RateLimitGroupingModel;

import java.util.Objects;
import java.util.function.Function;
import java.util.function.Supplier;

/**
* This is a temporary class to use while we refactor all the request managers. After all the request managers extend
* this class we'll move this functionality directly into the {@link BaseRequestManager}.
*/
public class GenericRequestManager<T extends InferenceInputs> extends BaseRequestManager {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once all the request managers are refactored, I envision that we'll be able to move this logic up into the base class.

private static final Logger logger = LogManager.getLogger(GenericRequestManager.class);

protected final ResponseHandler responseHandler;
protected final Function<T, Request> requestCreator;
protected final Class<T> inputType;

public GenericRequestManager(
ThreadPool threadPool,
RateLimitGroupingModel rateLimitGroupingModel,
ResponseHandler responseHandler,
Function<T, Request> requestCreator,
Class<T> inputType
) {
super(threadPool, rateLimitGroupingModel);
this.responseHandler = Objects.requireNonNull(responseHandler);
this.requestCreator = Objects.requireNonNull(requestCreator);
this.inputType = Objects.requireNonNull(inputType);
}

@Override
public void execute(
InferenceInputs inferenceInputs,
RequestSender requestSender,
Supplier<Boolean> hasRequestCompletedFunction,
ActionListener<InferenceServiceResults> listener
) {
var request = requestCreator.apply(inferenceInputs.castTo(inputType));

execute(new ExecutableInferenceRequest(requestSender, logger, request, responseHandler, hasRequestCompletedFunction, listener));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static IllegalArgumentException createUnsupportedTypeException(InferenceI
);
}

public <T> T castTo(Class<T> clazz) {
public <T extends InferenceInputs> T castTo(Class<T> clazz) {
if (clazz.isInstance(this) == false) {
throw createUnsupportedTypeException(this, clazz);
}
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Loading