-
Notifications
You must be signed in to change notification settings - Fork 824
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract ResponseFormat to standalone class
- Extracts ResponseFormat from being a nested record in OpenAiApi to a dedicated class with builder pattern support. - Resolve the issue with constructor bindings for the Boog property binding. - Re-enables previously disabled response format integration tests. - Add checkstyle changes - Add schema field in ResponseFormat and set jsonSchema via the setter for schema, this way schema set via a Boot property also sets the correct JsonSchema - Add default constructors in ResponseFormat and JsonSchema Resolves #1681
- Loading branch information
1 parent
fb65ed0
commit 83f7164
Showing
6 changed files
with
293 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
286 changes: 286 additions & 0 deletions
286
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/ResponseFormat.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,286 @@ | ||
| /* | ||
| * Copyright 2023-2024 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.ai.openai.api; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonInclude.Include; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
|
|
||
| import org.springframework.ai.model.ModelOptionsUtils; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| /** | ||
| * An object specifying the format that the model must output. | ||
| * | ||
| * Setting the type to JSON_SCHEMA, enables Structured Outputs which ensures the model | ||
| * will match your supplied JSON schema. Learn more in the | ||
| * <a href="https://platform.openai.com/docs/guides/structured-outputs"> Structured | ||
| * Outputs guide.</a <br/> | ||
| * | ||
| * References: <a href= | ||
| * "https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format">OpenAi | ||
| * API - ResponseFormat</a>, | ||
| * <a href="https://platform.openai.com/docs/guides/structured-outputs#json-mode">JSON | ||
| * Mode</a>, <a href= | ||
| * "https://platform.openai.com/docs/guides/structured-outputs#structured-outputs-vs-json-mode">Structured | ||
| * Outputs vs JSON mode</a> | ||
| * | ||
| * @author Christian Tzolov | ||
| * @since 1.0.0 | ||
| */ | ||
|
|
||
| @JsonInclude(Include.NON_NULL) | ||
| public class ResponseFormat { | ||
|
|
||
| /** | ||
| * Type Must be one of 'text', 'json_object' or 'json_schema'. | ||
| */ | ||
| @JsonProperty("type") | ||
| private Type type; | ||
|
|
||
| /** | ||
| * JSON schema object that describes the format of the JSON object. Only applicable | ||
| * when type is 'json_schema'. | ||
| */ | ||
| @JsonProperty("json_schema") | ||
| private JsonSchema jsonSchema = null; | ||
|
|
||
| private String schema; | ||
|
|
||
| public ResponseFormat() { | ||
|
|
||
| } | ||
|
|
||
| public Type getType() { | ||
| return this.type; | ||
| } | ||
|
|
||
| public void setType(Type type) { | ||
| this.type = type; | ||
| } | ||
|
|
||
| public JsonSchema getJsonSchema() { | ||
| return this.jsonSchema; | ||
| } | ||
|
|
||
| public void setJsonSchema(JsonSchema jsonSchema) { | ||
| this.jsonSchema = jsonSchema; | ||
| } | ||
|
|
||
| public String getSchema() { | ||
| return this.schema; | ||
| } | ||
|
|
||
| public void setSchema(String schema) { | ||
| this.schema = schema; | ||
| if (schema != null) { | ||
| this.jsonSchema = JsonSchema.builder().schema(schema).strict(true).build(); | ||
| } | ||
| } | ||
|
|
||
| private ResponseFormat(Type type, JsonSchema jsonSchema) { | ||
| this.type = type; | ||
| this.jsonSchema = jsonSchema; | ||
| } | ||
|
|
||
| public ResponseFormat(Type type, String schema) { | ||
| this(type, StringUtils.hasText(schema) ? JsonSchema.builder().schema(schema).strict(true).build() : null); | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| ResponseFormat that = (ResponseFormat) o; | ||
| return this.type == that.type && Objects.equals(this.jsonSchema, that.jsonSchema); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(this.type, this.jsonSchema); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "ResponseFormat{" + "type=" + this.type + ", jsonSchema=" + this.jsonSchema + '}'; | ||
| } | ||
|
|
||
| public static final class Builder { | ||
|
|
||
| private Type type; | ||
|
|
||
| private JsonSchema jsonSchema; | ||
|
|
||
| private Builder() { | ||
| } | ||
|
|
||
| public Builder type(Type type) { | ||
| this.type = type; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder jsonSchema(JsonSchema jsonSchema) { | ||
| this.jsonSchema = jsonSchema; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder jsonSchema(String jsonSchema) { | ||
| this.jsonSchema = JsonSchema.builder().schema(jsonSchema).build(); | ||
| return this; | ||
| } | ||
|
|
||
| public ResponseFormat build() { | ||
| return new ResponseFormat(this.type, this.jsonSchema); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| public enum Type { | ||
|
|
||
| /** | ||
| * Generates a text response. (default) | ||
| */ | ||
| @JsonProperty("text") | ||
| TEXT, | ||
|
|
||
| /** | ||
| * Enables JSON mode, which guarantees the message the model generates is valid | ||
| * JSON. | ||
| */ | ||
| @JsonProperty("json_object") | ||
| JSON_OBJECT, | ||
|
|
||
| /** | ||
| * Enables Structured Outputs which guarantees the model will match your supplied | ||
| * JSON schema. | ||
| */ | ||
| @JsonProperty("json_schema") | ||
| JSON_SCHEMA | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * JSON schema object that describes the format of the JSON object. Applicable for the | ||
| * 'json_schema' type only. | ||
| */ | ||
| @JsonInclude(Include.NON_NULL) | ||
| public static class JsonSchema { | ||
|
|
||
| @JsonProperty("name") | ||
| private String name; | ||
|
|
||
| @JsonProperty("schema") | ||
| private Map<String, Object> schema; | ||
|
|
||
| @JsonProperty("strict") | ||
| private Boolean strict; | ||
|
|
||
| public JsonSchema() { | ||
|
|
||
| } | ||
|
|
||
| public String getName() { | ||
| return this.name; | ||
| } | ||
|
|
||
| public Map<String, Object> getSchema() { | ||
| return this.schema; | ||
| } | ||
|
|
||
| public Boolean getStrict() { | ||
| return this.strict; | ||
| } | ||
|
|
||
| private JsonSchema(String name, Map<String, Object> schema, Boolean strict) { | ||
| this.name = name; | ||
| this.schema = schema; | ||
| this.strict = strict; | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(this.name, this.schema, this.strict); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| JsonSchema that = (JsonSchema) o; | ||
| return Objects.equals(this.name, that.name) && Objects.equals(this.schema, that.schema) | ||
| && Objects.equals(this.strict, that.strict); | ||
| } | ||
|
|
||
| public static final class Builder { | ||
|
|
||
| private String name = "custom_schema"; | ||
|
|
||
| private Map<String, Object> schema; | ||
|
|
||
| private Boolean strict = true; | ||
|
|
||
| private Builder() { | ||
| } | ||
|
|
||
| public Builder name(String name) { | ||
| this.name = name; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder schema(Map<String, Object> schema) { | ||
| this.schema = schema; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder schema(String schema) { | ||
| this.schema = ModelOptionsUtils.jsonToMap(schema); | ||
| return this; | ||
| } | ||
|
|
||
| public Builder strict(Boolean strict) { | ||
| this.strict = strict; | ||
| return this; | ||
| } | ||
|
|
||
| public JsonSchema build() { | ||
| return new JsonSchema(this.name, this.schema, this.strict); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.