added @JsonIgnore to ResponseFormat.schema to avoid exposing internal properties (#2969)

Signed-off-by: g00glen00b <[email protected]>

Author: g00glen00b

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/ResponseFormat.java

@@ -19,6 +19,7 @@
 import java.util.Map;
 import java.util.Objects;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -62,6 +63,7 @@ public class ResponseFormat {
 	@JsonProperty("json_schema")
 	private JsonSchema jsonSchema = null;
 
+	@JsonIgnore
 	private String schema;
 
 	public ResponseFormat() {

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/chat/OpenAiChatModelResponseFormatIT.java

@@ -139,6 +139,49 @@ void jsonSchema() throws JsonMappingException, JsonProcessingException {
 		assertThat(isValidJson(content)).isTrue();
 	}
 
+	@Test
+	void jsonSchemaThroughIndividualSetters() throws JsonMappingException, JsonProcessingException {
+
+		var jsonSchema = """
+				{
+					"type": "object",
+					"properties": {
+						"steps": {
+							"type": "array",
+							"items": {
+								"type": "object",
+								"properties": {
+									"explanation": { "type": "string" },
+									"output": { "type": "string" }
+								},
+								"required": ["explanation", "output"],
+								"additionalProperties": false
+							}
+						},
+						"final_answer": { "type": "string" }
+					},
+					"required": ["steps", "final_answer"],
+					"additionalProperties": false
+				}
+				""";
+
+		var responseFormat = new ResponseFormat();
+		responseFormat.setType(ResponseFormat.Type.JSON_SCHEMA);
+		responseFormat.setSchema(jsonSchema);
+		Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
+				OpenAiChatOptions.builder().model(ChatModel.GPT_4_O_MINI).responseFormat(responseFormat).build());
+
+		ChatResponse response = this.openAiChatModel.call(prompt);
+
+		assertThat(response).isNotNull();
+
+		String content = response.getResult().getOutput().getText();
+
+		logger.info("Response content: {}", content);
+
+		assertThat(isValidJson(content)).isTrue();
+	}
+
 	@Test
 	void jsonSchemaBeanConverter() throws JsonMappingException, JsonProcessingException {