RetrieveAssistantAsync is throwing System.Text.Json.JsonException

[edvanr]

Bug Report

Overview

After upgrading to 8.2.2 my calls to AssistantsEndpoint.RetrieveAssistantAsync started throwing a System.Text.Json.JsonException exception with a message The JSON value could not be converted to OpenAI.ResponseFormatObject. I had to rollback to 8.1.2 to resolve the issue so it looks like it has been around for a few releases.

To Reproduce

Steps to reproduce the behavior:

var assistant = await client.AssistantsEndpoint.RetrieveAssistantAsync(assistantId, cancellationToken);

Expected behavior

No exception gets thrown

Additional context

Here is the exception

System.Text.Json.JsonException
  HResult=0x80131500
  Message=The JSON value could not be converted to OpenAI.ResponseFormatObject. Path: $.response_format | LineNumber: 15 | BytePositionInLine: 27.
  Source=System.Text.Json
  StackTrace:
   at System.Text.Json.ThrowHelper.ThrowJsonException_DeserializeUnableToConvertValue(Type propertyType)
   at System.Text.Json.Serialization.Converters.ObjectDefaultConverter`1.OnTryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)
   at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
   at System.Text.Json.Serialization.Metadata.JsonPropertyInfo`1.ReadJsonAndSetMember(Object obj, ReadStack& state, Utf8JsonReader& reader)
   at System.Text.Json.Serialization.Converters.ObjectDefaultConverter`1.OnTryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)
   at System.Text.Json.Serialization.JsonConverter`1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)
   at System.Text.Json.Serialization.JsonConverter`1.ReadCore(Utf8JsonReader& reader, JsonSerializerOptions options, ReadStack& state)
   at System.Text.Json.JsonSerializer.ReadFromSpan[TValue](ReadOnlySpan`1 utf8Json, JsonTypeInfo`1 jsonTypeInfo, Nullable`1 actualByteCount)
   at System.Text.Json.JsonSerializer.ReadFromSpan[TValue](ReadOnlySpan`1 json, JsonTypeInfo`1 jsonTypeInfo)
   at System.Text.Json.JsonSerializer.Deserialize[TValue](String json, JsonSerializerOptions options)
   at OpenAI.Extensions.ResponseExtensions.Deserialize[T](HttpResponseMessage response, String json, OpenAIClient client)
   at OpenAI.Assistants.AssistantsEndpoint.<RetrieveAssistantAsync>d__6.MoveNext()

[StephenHodgson]

@edvanr can you give me a more complete code snippet to reproduce this?

Thanks

[edvanr]

Hi @StephenHodgson ,
I tried to write some test code which basically did this...

using var api = new OpenAIClient("API KEY");
var newAssistant = await api.AssistantsEndpoint.CreateAssistantAsync(new OpenAI.Assistants.CreateAssistantRequest(name: "Test assistant"));
var retrieveAssistant = await api.AssistantsEndpoint.RetrieveAssistantAsync(newAssistant.Id);

This worked fine and it seems to be happening for my existing assistants, however newly created ones are fine.

I intercepted the JSON coming back from the API with the RetrieveAssistant call and noticed the response_format looks different for my legacy Assistants versus a newly created one. Hope this helps...

Legacy Assistant...
"response_format": "auto"

Newly created assistant
"response_format": { "type": "text" }

[StephenHodgson]

Ah yes, if you assistants were generated during the v1 beta then they are not compatible sorry

[edvanr]

Ok so I logged into platform.openai.com selected my legacy Assistants and although "Text" was selected I reselected it, the app saved and now the format looks like it is coming back correctly and working.

Not sure if it is worth supporting the old format or just get users to update the format in the console...

[StephenHodgson]

I warned it was in Beta, and don't really feel like it was worth the effort to support tbh. It was a heavy enough lift to convert to v2 beta.