[BUG] `MessageImageDetail.Auto` fails for `assistantClient.CreateMessageAsync` in version 2.2.0

[moshe-ritterman]

Describe the bug

I just upgraded from version 2.1.0 to 2.2.0 and this code (see below) started to fail with this error message

HTTP 400 (invalid_request_error: invalid_value)
Parameter: content[1].image_file.detail

Invalid value: 'Auto'. Supported values are: 'low', 'high', and 'auto'.

This is the code that fails

await _assistantClient.CreateMessageAsync(threadId, MessageRole.User, [
        "<Some instructions>",
        MessageContent.FromImageFileId(fileId, MessageImageDetail.Auto),
        """
        Additional context: <Some more instructions>
        """
    ]
);

Steps to reproduce

1. Create a chat assistant (using AssistantClient)
2. Create a vector store (using VectorStoreClient)
3. Upload 2 files (using OpenAIFileClient)
4. Adding one of the files to the vector store (using VectorStoreClient)
5. Creating a thread (using AssistantClient) and attaching the vector store to the thread
6. Creating a message (using AssistantClient) passing in the thread id and the other file uploaded via OpenAIFileClient

It's at this step (where I attach the file) that I indicate that the image detail should be set to 'auto' via this code MessageContent.FromImageFileId(fileId, MessageImageDetail.Auto) and this is what fails (because 'Auto' is capitalized)

Code snippets

OS

macOS

.NET version

8

Library version

2.2.0

[moshe-ritterman]

p.s. I doubt that this issue is limited to MessageImageDetail.Auto it's probably the same with MessageImageDetail.High and MessageImageDetail.Low since the issue is with casing

[jsquire]

Hi @moshe-ritterman. Thanks for reaching out and we regret that you're experiencing difficulties. I can confirm this a serialization bug in the client where the enumeration is not being properly lower-cased. We'll look at getting this fixed up.

In the meantime, you can work around this by creating the expected payload and deserializing, which would look something like:

var fileId = "<< YOUR FILE ID >>";
var fileMessage = ModelReaderWriter.Read<MessageContent>(BinaryData.FromObjectAsJson(new
{
    type = "image_file",
    image_file = new
    {
        file_id = fileId,
        detail = "auto"
    }
}), ModelReaderWriterOptions.Json);

await _assistantClient.CreateMessageAsync(threadId, MessageRole.User, [
        "<Some instructions>",
        fileMessage
        """
        Additional context: <Some more instructions>
        """
    ]
);

[jsquire]

@ShivangiReja: Can you please take a look? From a quick glance, it seems like this is a problem for all of the MessageContent factories associated with assistants. For example, FromImageFileId is calling detail?.ToString() rather than detail?.ToString().ToLowerInvariant() causing a case mismatch.

[ShivangiReja]

Thank you so much for raising this issue, @moshe-ritterman and you're absolutely right. The problem wasn't limited to MessageImageDetail.Auto; it also affected High and Low due to incorrect casing. We've fixed it across all values in the factory methods to ensure they now serialize as expected.

[ShivangiReja]

Thanks, @jsquire! You’re absolutely right. The issue was indeed in the factory methods not calling ToLowerInvariant(), which the service expects for MessageImageDetail values. I’ve addressed this in the PR here: #544