[Inference API] Add custom headers for Azure OpenAI Service by jonathan-buttner · Pull Request #142969 · elastic/elasticsearch

jonathan-buttner · 2026-02-24T15:54:38Z

This PR adds custom headers support for the Azure OpenAI service.

Notable changes:

This mostly follows the same approach from the PR here: [ML] Adding custom headers support openai text embeddings #134960
Refactors the completion and embedding task settings to leverage a base class that does most of the work
This only supports a single header key. The http spec allows for multiple but we had already done a single key in the previous PR so I stuck with that
I took a shot at using ConstructingObjectParser instead of parsing from a map to start that transition

Testing

Create a deployment in Azure
Create endpoint with a header that would overwrite the api key

PUT _inference/text_embedding/azure
{
    "service": "azureopenai",
    "service_settings": {
        "api_key": "<api key>",
        "resource_name": "jonathan-buttner-test",
        "deployment_id": "jon-text-embedding",
        "api_version": "2023-05-15"
    },
    "task_settings": {
        "headers": {
            "api-key": "jon-test"
        }
    }
}

The creation request should fail because the api key is invalid when overwritten by the custom header.

Updating

To unset user, specify "user": null. To unset headers either send "headers": null or "headers": {}

PUT _inference/text_embedding/azure/_update
{
    "task_settings": {
        "user": null,
        "headers": null
    }
}

…-headers

elasticsearchmachine · 2026-02-24T15:55:04Z

Hi @jonathan-buttner, I've created a changelog YAML for you.

jonathan-buttner · 2026-02-24T16:43:19Z

...earch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionTaskSettings.java

+    };

-    private final String user;
+    public static final AzureOpenAiCompletionTaskSettings EMPTY = FACTORY.emptySettings();


This is doing some weird stuff to avoid the empty instance and factory depending on each other during initialization.

More information here: https://github.com/elastic/elasticsearch/pull/142969/changes#diff-a84378b3ed8b308ba6b3492e327a46706de1f8dbca5ed50db2134aec40381b4fR79-R83

// Ideally we'd be able to pass the empty instance in via the Factory constructor, but since the empty instance relies on the // factory to be created, we have to lazily create it here. The empty instance will call the AzureOpenAiTaskSettings // constructor with the factory. If we don't do it this way we end up getting an NPE in the constructor because the factory // hasn't finished initialization yet.

jonathan-buttner · 2026-02-24T16:46:34Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+ * Base class for Azure OpenAI task settings (embeddings and completion). Holds optional user and optional
+ * custom HTTP headers via {@link Headers}.
+ */
+public abstract class AzureOpenAiTaskSettings<T extends AzureOpenAiTaskSettings<T>> implements TaskSettings {


This generally follows the same pattern that we started in OpenAiTaskSettings except this class leverages a ConstructingObjectParser to parse out the fields. Since we'd like to move in that direction, hopefully this will make that easier in the future.

jonathan-buttner · 2026-02-24T16:46:49Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+        );
+
+        constructingObjectParser.declareString(optionalConstructorArg(), new ParseField(AzureOpenAiServiceFields.USER));
+        Headers.initParser(constructingObjectParser);


Apply the header parsing logic to the constructing object parser.

this is where we would call parser.declareObject(optionalConstructorArg(), Headers.PARSER, new ParseField("headers") or something

Yeah I was struggling with that. The issue I see is that headers is only a map so there isn't another level for parsing. For example if we had this:

{ "headers: { "some_other_field": { ... } } }

Then the headers class could have a parser that explicitly looks for some_other_field. But headers just wants it as a map. Like imagine headers was a string with some special parsing logic around it. How would we leverage a parser that was wrapping a string.

In the examples I've seen we typically declare another parser if it encapsulates a whole object.

Ah, yes, of course. Makes sense 👍

jonathan-buttner · 2026-02-24T16:49:06Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+        Factory<T> factory
+    ) {
+        if (map.isEmpty()) {
+            return factory.emptySettings();


Another option I looked into was to use an abstract method on the AzureOpenAiTaskSettings class to handle "creating" the right type of an empty instance. The problem is that we're in a static context here and to avoid having to construct a new object entirely we need to do it in a static method.

OpenAiTaskSettings doesn't leverage empty instances and requires an object to be created each time.

jonathan-buttner · 2026-02-24T16:50:06Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+
+        try {
+            try (
+                var xContent = XContentBuilder.builder(JsonXContent.jsonXContent).map(map);


This converts a Map to json and then parses it.

jonathan-buttner · 2026-02-24T16:52:23Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+    }
+
+    @Override
+    public T updatedTaskSettings(Map<String, Object> newSettings) {


This doesn't try to return an empty instance. To return an empty instance we'd need to cast to T I think. I don't think it's worth it because in the flow of a request including task settings the caller will check if the task settings are empty and return the same model. This will also be called in the update api flow but I don't think that needs to be very memory conscious.

If you have other ideas I'm open to improving this though.

I'm fine with this as it is, but one option would be to have an abstract emptyInstance() method on this class and then add

if (userToUse.isUndefined() && headersToUse.value().isUndefined()) { return emptyInstance(); }

at the end of this method.

Good idea, we actually have this via the factory already 🙌 so I'll add the if block.

jonathan-buttner · 2026-02-24T17:02:39Z

.../inference/services/azureaistudio/embeddings/AzureAiStudioEmbeddingsRequestTaskSettings.java

     *
     * @param map the settings received from a request
-     * @return a {@link AzureOpenAiEmbeddingsRequestTaskSettings}
+     * @return a {@link AzureAiStudioEmbeddingsRequestTaskSettings}


This was referencing the wrong class

…-headers

…csearch into ia-azure-headers

elasticsearchmachine · 2026-02-24T20:34:45Z

Pinging @elastic/search-inference-team (Team:Search - Inference)

Copilot

Pull request overview

This PR adds support for specifying custom HTTP headers in Azure OpenAI inference task settings, refactoring Azure OpenAI completion/embeddings task settings to share a common base parser/serialization implementation and improving parse-error unwrapping.

Changes:

Introduces a reusable Headers parser/value object and wires it into Azure OpenAI task settings and request construction.
Refactors Azure OpenAI completion/embeddings task settings to extend a new AzureOpenAiTaskSettings base (incl. transport version gating).
Updates/adds tests and transport version definitions, plus a changelog entry.

Reviewed changes

Copilot reviewed 35 out of 35 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/openai/OpenAiTaskSettingsTests.java	Updates assertions for revised map-type error messages.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/custom/CustomTaskSettingsTests.java	Updates expected error message type rendering for invalid parameter values.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/custom/CustomServiceSettingsTests.java	Updates header-validation error message assertions.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsTaskSettingsTests.java	Refactors embeddings task settings tests to inherit shared Azure OpenAI task settings test base.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsRequestTaskSettingsTests.java	Removes request-only task settings tests (request settings now handled via base parsing/updating).
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsModelTests.java	Updates model construction to include headers-aware task settings.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionTaskSettingsTests.java	Refactors completion task settings tests to inherit shared Azure OpenAI task settings test base.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionRequestTaskSettingsTests.java	Removes request-only task settings tests (now handled via base parsing/updating).
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionModelTests.java	Updates model construction to include headers-aware task settings.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/action/AzureOpenAiActionCreatorTests.java	Switches helper import to new shared Azure OpenAI task settings test utilities.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettingsTests.java	Adds shared test base covering user + headers parsing, updating, and BWC behavior.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiServiceTests.java	Updates expectations for request config parsing errors (now can surface `XContentParseException`).
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/services/ServiceUtilsTests.java	Updates error message assertions for type-name based reporting.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/common/parser/ParseExceptionUtilsTests.java	Adds tests for unwrapping `XContentParseException` chains.
x-pack/plugin/inference/src/test/java/org/elasticsearch/xpack/inference/common/parser/HeadersTests.java	Adds tests for parsing/serialization/validation of `headers`.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiRequest.java	Refactors Azure OpenAI request creation into a shared base and applies custom headers to outgoing requests.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiEmbeddingsRequest.java	Migrates embeddings request to extend `AzureOpenAiRequest` and delegates shared HTTP request creation.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiCompletionRequest.java	Migrates completion request to extend `AzureOpenAiRequest` and delegates shared HTTP request creation.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiChatCompletionRequest.java	Migrates chat completion request to extend `AzureOpenAiRequest` and delegates shared HTTP request creation.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsTaskSettings.java	Refactors embeddings task settings to extend shared `AzureOpenAiTaskSettings` and parse with context.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsRequestTaskSettings.java	Removes request-only task settings record (superseded by shared updating/parsing).
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/embeddings/AzureOpenAiEmbeddingsModel.java	Switches task settings parsing/updating to context-aware `AzureOpenAiTaskSettings` base behavior.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionTaskSettings.java	Refactors completion task settings to extend shared `AzureOpenAiTaskSettings` and parse with context.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionRequestTaskSettings.java	Removes request-only task settings record (superseded by shared updating/parsing).
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionModel.java	Switches task settings parsing/updating to context-aware `AzureOpenAiTaskSettings` base behavior.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java	Adds shared base for Azure OpenAI task settings (user + headers parsing, updating, BWC transport support).
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiService.java	Removes task-settings “empty map” post-parse check (unknown fields now enforced by parser in request context).
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiModel.java	Reintroduces typed accessor override for secret settings on the base model.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureaistudio/embeddings/AzureAiStudioEmbeddingsRequestTaskSettings.java	Fixes incorrect Javadoc reference after Azure OpenAI request-task-settings removal.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ServiceUtils.java	Changes map validation error messages to report value type via class name.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/ParseExceptionUtils.java	Adds helper to unwrap `XContentParseException` to a more actionable runtime exception.
x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java	Adds `Headers` record to parse/validate/serialize custom HTTP headers.
server/src/main/resources/transport/upper_bounds/9.4.csv	Bumps the 9.4 transport version upper bound to include new referable version.
server/src/main/resources/transport/definitions/referable/inference_azure_openai_task_settings_headers.csv	Adds referable transport version definition for Azure OpenAI task settings headers.
docs/changelog/142969.yaml	Adds changelog entry for Azure OpenAI custom headers support.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiService.java

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ServiceUtils.java

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

.../java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiRequest.java

...src/test/java/org/elasticsearch/xpack/inference/services/custom/CustomTaskSettingsTests.java

...in/inference/src/test/java/org/elasticsearch/xpack/inference/common/parser/HeadersTests.java

…inference/services/azureopenai/AzureOpenAiService.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…inference/services/azureopenai/request/AzureOpenAiRequest.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

dimitris-athanasiou · 2026-02-27T09:08:33Z

...n/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/StatefulValue.java

+        this.isDefined = isDefined;
+    }
+
+    public boolean isAbsent() {


Could we rename this to isUndefined()? Something bugs me about isPresent() XOR inAbsent() not always being true (when isNull() is true) :-)

dimitris-athanasiou · 2026-02-27T09:15:09Z

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java

+        this(read(in));
+    }
+
+    private static StatefulValue<Map<String, String>> read(StreamInput in) throws IOException {


Do we need this method? Could we not inline this in the Headers(StreamInput) constructor?

dimitris-athanasiou · 2026-02-27T10:11:59Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+        } catch (IOException e) {
+            throw new IllegalArgumentException("Failed to parse Azure OpenAI task settings", e);
+        } catch (XContentParseException e) {
+            throw unwrapXContentParseException(e);


Why do we want to unwrap here?

If we don't unwrap we'll get XContentParseException getCause -> XContentParseException getCause -> ValidationException

That'll look like this (from HeadersTests::testParse_ThrowsWhenValueNotString):

assertThat(exception.getMessage(), containsString("[headers_parser] failed to parse field [headers]")); assertThat(exception.getCause().getMessage(), containsString("Failed to build [headers_parser] after last required field arrived")); assertThat( exception.getCause().getCause().getMessage(), containsString( "Map field [root.headers] has an entry that is not valid, [key => 1]. Value type of [Integer] is not one of [String].;" ) );

The response in Elasticsearch will remove the top one but it'll still return the top exception as "Failed to build... after last required field arrived". I didn't think that was very helpful so I figured unwrapping might be better here so that the first exception is the validation one. That's also inline with how things worked previously when parsing using maps instead of ConstructingObjectParser.

The theory behind this is that when parsing an object that may have multiple fields, sub-fields, etc., the XContentParseException takes care of showing the exact location where the error happened. Here is an example output when parsing fails deep in a ML anomaly detection job:

Are we certain we don't want to leverage that in our inference parsing going forwards?

Ah interesting, ok I'll remove the unwrapping then 👍

dimitris-athanasiou · 2026-02-27T10:15:49Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+        "inference_azure_openai_task_settings_headers"
+    );
+
+    protected record Settings(StatefulValue<String> user, Headers headers) {


Do we make user stateful because we want to be able to set it to null?

Yeah my reasoning was that I thought it'd be a weird experience for a customer to be able to unset headers but not user. So I figured it'd probably be good to do it for both.

I think we should probably move in the direction of having any optional field allowed to be unset.

…-headers

…csearch into ia-azure-headers

DonalEvans

I think it's possible I was just confused about how we want things to work with the comments around how we persist null/empty user values, so apologies if that's the case.

DonalEvans · 2026-02-27T20:21:10Z

libs/x-content/src/main/java/org/elasticsearch/xcontent/AbstractObjectParser.java

@@ -288,6 +288,19 @@ public void declareStringOrNull(BiConsumer<Value, String> consumer, ParseField f
        );
    }

+    /**
+     * Declare a field of type {@code T} parsed from string and converted to {@code T} using provided function,


I think this comment needs to be adjusted, since no function is provided and the type is always String

DonalEvans · 2026-02-27T20:37:01Z

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java


    public static <Value, Context> void initParser(ConstructingObjectParser<Value, Context> parser) {
-        parser.declareObjectOrNull(optionalConstructorArg(), (p, c) -> p.mapOrdered(), null, HEADERS);
+        parser.declareObjectOrNull(optionalConstructorArg(), (p, c) -> {
+            var orderedMap = p.mapOrdered();


Is there a reason we want to use an ordered map here rather than just a map?

Naa I'll switch it to a map.

DonalEvans · 2026-02-27T20:53:51Z

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java

+        var stringsMap = doValidation((Map<String, Object>) arg, validationException);
+
+        if (stringsMap.isEmpty()) {
+            return UNDEFINED_INSTANCE;


Is this correct? I think to get here, the user would have had to specify headers as an empty map in the task settings, which to me feels like it's defined but empty rather than being undefined. If I was a user who wanted to clear the headers I'd previously set, I could see specifying an empty map for the headers field being one way of doing that, with another being setting the field to null explicitly.

Yeah fair point. I'll switch this to return the NULL_INSTANCE and leave a comment describing that we're considering this the same situation as when a user wants to remove the headers.

DonalEvans · 2026-02-27T20:58:29Z

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java

+        if (validationException.validationErrors().isEmpty() == false) {
+            throw validationException;
+        }


This can be simplified to validationException.throwIfValidationErrorsExist();

DonalEvans · 2026-02-27T21:11:21Z

.../plugin/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/Headers.java

 import java.util.Map;
 import java.util.Objects;

 import static org.elasticsearch.xcontent.ConstructingObjectParser.optionalConstructorArg;
 import static org.elasticsearch.xpack.inference.services.ServiceUtils.removeNullValues;
 import static org.elasticsearch.xpack.inference.services.ServiceUtils.validateMapStringValues;

-public record Headers(Map<String, String> headersMap) implements ToXContentFragment, Writeable {
+public record Headers(StatefulValue<Map<String, String>> value) implements ToXContentFragment, Writeable {


Nitpick, but this might be better named "mapValue" or even just "map", since "value" is a bit vague. I'm thinking along the same lines as how we might typically name an AtomicReference, where instead of calling them all "reference" the name usually refers to what they're a reference to.

DonalEvans · 2026-02-27T22:55:55Z

.../src/test/java/org/elasticsearch/xpack/inference/common/parser/ParseExceptionUtilsTests.java

+     * With {@code counter++ >= 10}, 10 getCause() steps are allowed; a chain of 11
+     * XContentParseExceptions causes the 11th (index 10) to be returned when the limit is hit.
+     */
+    public void testUnwrap_StopsAtTenLevels_ReturnsExceptionAtLimit() {


Ideally this test would have a chain of more than 11 exceptions and confirm that we stop before getting to the last one. As is, this test would still pass even if we never stopped unwrapping exceptions. I think that this should give the coverage we want:

public void testUnwrap_StopsAtTenLevels_ReturnsExceptionAtLimit() { XContentParseException toReturn = null; var chain = new XContentParseException[MAX_UNWRAP_DEPTH + 5]; for (var i = chain.length - 1; i > 0; i--) { chain[i - 1] = new XContentParseException(null, "level " + i, chain[i]); if (i == MAX_UNWRAP_DEPTH) { toReturn = chain[i]; } } var result = ParseExceptionUtils.unwrapXContentParseException(chain[0]); assertThat(result, sameInstance(toReturn)); // Confirm there were more nested exceptions that we didn't try to unwrap assertThat(result.getCause(), notNullValue()); }

Good point, I removed this class and tests based on Dimitris recommendation because we're no longer unwrapping 👍

DonalEvans · 2026-02-27T23:00:56Z

...n/inference/src/main/java/org/elasticsearch/xpack/inference/common/parser/StatefulValue.java

+    }
+
+    public static <T> StatefulValue<T> of(T value) {
+        return new StatefulValue<>(Objects.requireNonNull(value), true);


Very minor nitpick, but if we want to more closely align with the behaviour of Optional, we could throw new NoSuchElementException("No value present") here instead of an NPE.

DonalEvans · 2026-02-27T23:08:00Z

...erence/src/test/java/org/elasticsearch/xpack/inference/common/parser/StatefulValueTests.java

+        var value = randomAlphaOfLength(10);
+        assertEquals(StatefulValue.of(value), StatefulValue.of(value));


To make this test stronger, I think we should be passing in two different instances of equal values here:

var map = new HashMap<>(Map.of(randomAlphaOfLength(10), randomAlphaOfLength(10))); var equalMap = new HashMap<>(map); assertEquals(StatefulValue.of(map), StatefulValue.of(equalMap));

this makes sure that we're actually properly testing the equality of the wrapped objects instead of just doing ==.

The same comment applies to the hashCode() test below this one. It might even be better to have one test that covers both equals() and hashCode() since then it's more obvious that we're first establishing that two values are equal, then that they also have the same hashcode.

DonalEvans · 2026-02-27T23:16:30Z

...ava/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettingsTests.java

+    private String randomUser() {
+        return randomBoolean() ? null : randomAlphaOfLength(15);
+    }


For full coverage, it would be good to have the chance of returning an empty String for user as well as null. I think adding that will help surface a bug in the toXContent() implementation.

"user": "" will return a validation error for the parsing logic. I've tried to test explicitly with an empty string where applicable (when in persistent context).

DonalEvans · 2026-02-27T23:17:43Z

...ava/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettingsTests.java

            containsString(
-                "Map field [task_settings.headers] has an entry that is not valid, [key => 1]. Value type of [Integer] is not one of [String]."
+                "Map field [headers] has an entry that is not " + "valid, [key => 1]. Value type of [Integer] is not one of [String].;"


We can join these two strings.

…-headers

jonathan-buttner · 2026-03-02T20:45:09Z

...earch/xpack/inference/services/azureopenai/completion/AzureOpenAiCompletionTaskSettings.java

+    private static final AzureOpenAiTaskSettings.Factory<AzureOpenAiCompletionTaskSettings> FACTORY = new Factory<>() {
+        @Override
+        public AzureOpenAiCompletionTaskSettings create(CommonSettings commonSettings) {
+            return new AzureOpenAiCompletionTaskSettings(commonSettings);


I decided to not check for isEmpty() here because it was causing a bug where commonSettings had user.nullInstance() and headers.nullInstance() it'd return true and we'd return the empty instance even though we want the null state. We could do a check for something like user.isUndefined() && headers.isUndefined() but I'm not sure it's worth it.

…csearch into ia-azure-headers

DonalEvans · 2026-03-02T21:25:12Z

...ain/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettings.java

+        if (user.isPresent() && user.get().isEmpty() == false) {
+            builder.field(AzureOpenAiServiceFields.USER, user.get());
        }


Okay, that should be fine then

DonalEvans · 2026-03-02T21:48:24Z

...ava/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiTaskSettingsTests.java

        if (newSettings.user().isPresent()) {
            newSettingsMap.put(AzureOpenAiServiceFields.USER, newSettings.user().get());
+        } else if (newSettings.user().isNull()) {
+            newSettingsMap.put(AzureOpenAiServiceFields.USER, null);
        }

        if (newSettings.headers().isPresent()) {
-            newSettingsMap.put(Headers.HEADERS_FIELD, new HashMap<>(newSettings.headers().value().get()));
+            newSettingsMap.put(Headers.HEADERS_FIELD, new HashMap<>(newSettings.headers().mapValue().get()));
+        } else if (newSettings.headers().isNull()) {
+            newSettingsMap.put(Headers.HEADERS_FIELD, null);
        }


This can be simplified to:

if (newSettings.user().isUndefined() == false) { newSettingsMap.put(AzureOpenAiServiceFields.USER, newSettings.user().orElse(null)); } if (newSettings.headers().mapValue().isUndefined() == false) { newSettingsMap.put(Headers.HEADERS_FIELD, newSettings.headers().mapValue().orElse(null)); }

…-headers

…142969) * Adding headers file * Using base class for task settings * Refactoring base class to allow for returning empty instance * Fixing test failures * Fixing test * Update docs/changelog/142969.yaml * [CI] Auto commit changes from spotless * clean up and consolidating request header logic * Returning validation exception instead of xcontent when possible * Adding unwrapper utils tests * Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiService.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiRequest.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * [CI] Auto commit changes from spotless * Address chatgpt feedback * Adding test for unwrap exception * Working refactor * Removing duplicate method * Adding tests for statefulvalue * Using a single model reference * Fixing test and renaming * Fixing tests and refactoring validation * [CI] Auto commit changes from spotless * Removing exception unwrap logic * Addressing feedback * [CI] Auto commit changes from spotless * Allowing null in update api * Using orElse --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…locations * upstream/main: (51 commits) ESQL: Remaining serialization tests (elastic#143470) Eagerly release resources in `TransportAwaitClusterStateVersionAppliedAction` (elastic#143477) Stop and relocate sliced reindex on shutdown (elastic#143183) Documentation for query_vector base64 parameter (elastic#142675) ES|QL: Fix LIMIT after all columns are dropped (elastic#143463) Update docs-build.yml (elastic#142958) Fix KnnIndexTester to work with byte vectors (elastic#143493) Fix IndexInputUtils.withSlice to produce native-safe MemorySegments on Java 21 (elastic#143479) CPS fix: include only relevant projects in the search response metadata (elastic#143367) apm-data: explicit map of timestamp.us to long (elastic#143173) [Inference API] Add custom headers for Azure OpenAI Service (elastic#142969) ESQL: Add name IDs to golden tests and fix synthetic names (elastic#143450) Add getUnavailableShards to BaseBroadcastResponse (elastic#143406) Add description to reindex API without sensitive info (elastic#143112) SQL: fix CLI tests (elastic#143451) ES|QL: Add note of future removal of FORK implicit LIMIT (elastic#143457) [Test] Randomly disable doc values skippers in time-series indices (elastic#143389) Improve pattern text downgrade license test (elastic#143102) [Transform] Stop transforms at the end of tests (elastic#139783) Mute org.elasticsearch.compute.lucene.read.ValueSourceReaderTypeConversionTests testLoadAll elastic#143471 ...

…142969) * Adding headers file * Using base class for task settings * Refactoring base class to allow for returning empty instance * Fixing test failures * Fixing test * Update docs/changelog/142969.yaml * [CI] Auto commit changes from spotless * clean up and consolidating request header logic * Returning validation exception instead of xcontent when possible * Adding unwrapper utils tests * Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/AzureOpenAiService.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/azureopenai/request/AzureOpenAiRequest.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * [CI] Auto commit changes from spotless * Address chatgpt feedback * Adding test for unwrap exception * Working refactor * Removing duplicate method * Adding tests for statefulvalue * Using a single model reference * Fixing test and renaming * Fixing tests and refactoring validation * [CI] Auto commit changes from spotless * Removing exception unwrap logic * Addressing feedback * [CI] Auto commit changes from spotless * Allowing null in update api * Using orElse --------- Co-authored-by: elasticsearchmachine <infra-root+elasticsearchmachine@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jonathan-buttner added 6 commits February 20, 2026 14:08

Adding headers file

f2a21e9

Using base class for task settings

ebdb4a6

Refactoring base class to allow for returning empty instance

bb0907e

Fixing test failures

8cedcd0

Fixing test

c4b846d

Merge branch 'main' of github.com:elastic/elasticsearch into ia-azure…

e3d466f

…-headers

jonathan-buttner added >enhancement :SearchOrg/Inference Label for the Search Inference team Team:Search - Inference v9.4.0 labels Feb 24, 2026

Update docs/changelog/142969.yaml

bc2384e

elasticsearchmachine and others added 4 commits February 24, 2026 16:03

[CI] Auto commit changes from spotless

e7a8fc2

clean up and consolidating request header logic

56bf6dc

Returning validation exception instead of xcontent when possible

1f64d15

Adding unwrapper utils tests

4741068

jonathan-buttner commented Feb 24, 2026

View reviewed changes

jonathan-buttner added 2 commits February 24, 2026 15:30

Merge branch 'main' of github.com:elastic/elasticsearch into ia-azure…

f1e92f7

…-headers

Merge branch 'ia-azure-headers' of github.com:jonathan-buttner/elasti…

e55d554

…csearch into ia-azure-headers

jonathan-buttner marked this pull request as ready for review February 24, 2026 20:34

jonathan-buttner requested review from DonalEvans, Jan-Kazlouski-elastic, Copilot and dimitris-athanasiou February 24, 2026 20:34

Copilot started reviewing on behalf of jonathan-buttner February 24, 2026 20:35 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

jonathan-buttner and others added 3 commits February 24, 2026 15:43

Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/…

2eb28ce

…inference/services/azureopenai/AzureOpenAiService.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/…

838ede1

…inference/services/azureopenai/request/AzureOpenAiRequest.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

[CI] Auto commit changes from spotless

6242017

dimitris-athanasiou reviewed Feb 27, 2026

View reviewed changes

jonathan-buttner and others added 7 commits February 27, 2026 11:11

Fixing test and renaming

0b1cff0

Fixing transport version

80a2272

Fixing tests and refactoring validation

2b600d2

Merge branch 'main' of github.com:elastic/elasticsearch into ia-azure…

8ebbd3b

…-headers

[CI] Auto commit changes from spotless

710f8aa

Removing exception unwrap logic

83df8d5

Merge branch 'ia-azure-headers' of github.com:jonathan-buttner/elasti…

179d7b2

…csearch into ia-azure-headers

jonathan-buttner requested review from DonalEvans and dimitris-athanasiou February 27, 2026 20:53

DonalEvans reviewed Feb 27, 2026

View reviewed changes

jonathan-buttner added 2 commits March 2, 2026 15:39

Addressing feedback

30d256d

Merge branch 'main' of github.com:elastic/elasticsearch into ia-azure…

fe979eb

…-headers

jonathan-buttner commented Mar 2, 2026

View reviewed changes

jonathan-buttner requested a review from DonalEvans March 2, 2026 20:45

elasticsearchmachine and others added 3 commits March 2, 2026 20:48

[CI] Auto commit changes from spotless

c75b7f4

Allowing null in update api

e24b927

Merge branch 'ia-azure-headers' of github.com:jonathan-buttner/elasti…

3fe6c9e

…csearch into ia-azure-headers

DonalEvans approved these changes Mar 2, 2026

View reviewed changes

jonathan-buttner added 2 commits March 3, 2026 09:01

Merge branch 'main' of github.com:elastic/elasticsearch into ia-azure…

69b4732

…-headers

Using orElse

ef2b448

jonathan-buttner enabled auto-merge (squash) March 3, 2026 14:08

jonathan-buttner merged commit cf8bc46 into elastic:main Mar 3, 2026
34 of 35 checks passed

jonathan-buttner deleted the ia-azure-headers branch March 3, 2026 15:59

This was referenced Mar 6, 2026

[ML] Wait for cluster state in test #143767

Merged

[Transform] Disable PIT for CPS #143876

Closed

jonathan-buttner mentioned this pull request Mar 20, 2026

[Inference API] Adding custom headers for Azure OpenAI elastic/elasticsearch-specification#6134

Merged

		var value = randomAlphaOfLength(10);
		assertEquals(StatefulValue.of(value), StatefulValue.of(value));

Conversation

jonathan-buttner commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Updating

Uh oh!

elasticsearchmachine commented Feb 24, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticsearchmachine commented Feb 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DonalEvans left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner commented Feb 24, 2026 •

edited

Loading

jonathan-buttner Feb 27, 2026 •

edited

Loading

jonathan-buttner Mar 2, 2026 •

edited

Loading