Azure responseFormat no converter found

[JakobStadlhuber]

Bug description
When migrating Spring AI from version 1.0.0-M8 to 1.0.0, configuring the spring.ai.azure.openai.chat.options.response-format property with values such as text, json_object, or json_schema (which were changed from the previous json value) results in an application startup failure. The application fails to bind the string property value to the org.springframework.ai.azure.openai.AzureOpenAiResponseFormat type, throwing a ConverterNotFoundException.

Environment

• Spring AI version: 1.0.0 (migrating from 1.0.0-M8)
• Java version: 21
• Model Provider: Azure OpenAI

Steps to reproduce

1. Have a Spring Boot application using spring-ai-azure-openai-starter.
2. Previously, in version 1.0.0-M8 or earlier, have the property spring.ai.azure.openai.chat.options.responseFormat=json (or its equivalent) configured.
3. Upgrade the Spring AI version to 1.0.0.
4. Modify the configuration property to spring.ai.azure.openai.chat.options.response-format and set its value to one of the new supported formats, for example: spring.ai.azure.openai.chat.options.response-format=json_object.
5. Attempt to start the Spring Boot application.
6. Observe the APPLICATION FAILED TO START error with the ConverterNotFoundException.

Expected behavior
The application should start successfully with the spring.ai.azure.openai.chat.options.response-format property correctly bound to the AzureOpenAiResponseFormat type, allowing the Azure OpenAI chat client to use the specified response format (e.g., text, json_object, or json_schema).

Minimal Complete Reproducible example
A minimal complete reproducible example or failing test was not provided in the initial report. However, a simple Spring Boot application with the spring-ai-azure-openai-starter dependency and the following configuration in application.properties should trigger the issue:

application.properties:

spring.ai.azure.openai.api-key=<YOUR_AZURE_OPENAI_KEY>
spring.ai.azure.openai.endpoint=<YOUR_AZURE_OPENAI_ENDPOINT>
spring.ai.azure.openai.chat.options.deployment-name=<YOUR_DEPLOYMENT_NAME> # or model
spring.ai.azure.openai.chat.options.response-format=json_object # or text, or json_schema

A simple component attempting to use the ChatClient would be sufficient to trigger the context loading and property binding.

Error Log Snippet Provided:

***************************
APPLICATION FAILED TO START
***************************

Description:

Failed to bind properties under 'spring.ai.azure.openai.chat.options.response-format' to org.springframework.ai.azure.openai.AzureOpenAiResponseFormat:

    Reason: org.springframework.core.convert.ConverterNotFoundException: No converter found capable of converting from type [java.lang.String] to type [@com.fasterxml.jackson.annotation.JsonProperty org.springframework.ai.azure.openai.AzureOpenAiResponseFormat]

Action:
Review the value of the property. If the problem persists, check the DDL definition of the an @ConfigurationProperties bean if you have one.

[HyunSangHan]

May I work on this?

[HyunSangHan]

@JakobStadlhuber
I believe the key might have been used incorrectly.
Instead of spring.ai.azure.openai.chat.options.response-format,
could you try using the key in the form of spring.ai.azure.openai.chat.options.response-format.type?

- spring.ai.azure.openai.chat.options.response-format=...
+ spring.ai.azure.openai.chat.options.response-format.type=...

That might solve the issue.

(+) If it does work, I think it would be helpful to support an auto-completion feature, since users might not be aware of this and could misuse it easily.

[dev-jonghoonpark]

@HyunSangHan Good catch!

---

1. The responseFormat has been updated recently, but this change has not been reflected in the documentation.
   Link: https://docs.spring.io/spring-ai/reference/api/chat/azure-openai-chat.html
   The documentation needs to be updated accordingly.

2. In both OpenAI and Azure OpenAI, the sub-properties of response-format are not currently supported with auto-completion in application.properties and application.yaml files. It would be great if this could be improved.

[JakobStadlhuber]

@JakobStadlhuber I believe the key might have been used incorrectly. Instead of spring.ai.azure.openai.chat.options.response-format, could you try using the key in the form of spring.ai.azure.openai.chat.options.response-format.type?

• spring.ai.azure.openai.chat.options.response-format=...

• spring.ai.azure.openai.chat.options.response-format.type=...
  That might solve the issue.

(+) If it does work, I think it would be helpful to support an auto-completion feature, since users might not be aware of this and could misuse it easily.

Cannot resolve configuration property 'spring.ai.azure.openai.chat.options.response-format.type'

only

spring.ai.azure.openai.chat.options.response-format=${AZURE_OPENAI_RESPONSE_FORMAT:json_object} can be found but then i got this error.

and yes i use the newest 1.0.0 otherwise i would not get the new reponse-format when looking at the AzureOpenAiResponseFormat

[dev-jonghoonpark]

@JakobStadlhuber

Yes, you might see the warning:
Cannot resolve configuration property "spring.ai.azure.openai.chat.options.response-format.type".

However, it shouldn't affect the execution.

Did the execution fail?

[JakobStadlhuber]

The exceution has not failed?? Okay but why is it showing this "warning/error"?

[dev-jonghoonpark]

It ran without errors, right?

Currently, the documentation is not updated, and the sub-properties are not properly linked.

That's why I mentioned this earlier:

1. The responseFormat has been updated recently, but this change has not been reflected in the documentation.
   Link: https://docs.spring.io/spring-ai/reference/api/chat/azure-openai-chat.html
   The documentation needs to be updated accordingly.
2. In both OpenAI and Azure OpenAI, the sub-properties of response-format are not currently supported with auto-completion in application.properties and application.yaml files. It would be great if this could be improved.

[JakobStadlhuber]

okay yes it ran without errors.

[HyunSangHan]

I created an issue for the suggestion about auto-completion. -> #3430