feat (dotAI): support structured output for chatGTP (#31327)

Includes support for "response_format" in the request to dotAI completions
dotCMS · Feb 14, 2025 · 4550215 · 4550215
1 parent 8a67ede
commit 4550215
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/dotCMS/src/main/java/com/dotcms/ai/AiKeys.java b/dotCMS/src/main/java/com/dotcms/ai/AiKeys.java
@@ -61,6 +61,7 @@ public class AiKeys {
     public static final String LIMIT = "limit";
     public static final String COUNT = "count";
     public static final String INPUT = "input";
+    public static final String RESPONSE_FORMAT = "response_format";
 
     private AiKeys() {}
 

diff --git a/dotCMS/src/main/java/com/dotcms/ai/api/CompletionsAPIImpl.java b/dotCMS/src/main/java/com/dotcms/ai/api/CompletionsAPIImpl.java
@@ -184,6 +184,10 @@ private JSONObject buildRequestJson(final CompletionsForm form, final List<Embed
             json.put(AiKeys.MODEL, modelTuple._2.getName());
         }
 
+        if (UtilMethods.isSet(form.responseFormat)) {
+            json.put(AiKeys.RESPONSE_FORMAT, form.responseFormat);
+        }
+
         json.put(AiKeys.MAX_TOKENS, form.responseLengthTokens);
 
         return json;

diff --git a/dotCMS/src/main/java/com/dotcms/ai/client/openai/OpenAIClient.java b/dotCMS/src/main/java/com/dotcms/ai/client/openai/OpenAIClient.java
@@ -112,6 +112,7 @@ public <T extends Serializable> void sendRequest(final AIRequest<T> request, fin
             throw new DotAIModelNotOperationalException(String.format("Model [%s] is not operational", modelName));
         }
 
+
         final long sleep = lastRestCall.computeIfAbsent(aiModel, m -> 0L)
                 + aiModel.minIntervalBetweenCalls()
                 - System.currentTimeMillis();

diff --git a/dotCMS/src/main/java/com/dotcms/ai/rest/forms/CompletionsForm.java b/dotCMS/src/main/java/com/dotcms/ai/rest/forms/CompletionsForm.java
@@ -51,6 +51,7 @@ public class CompletionsForm {
     public final String operator;
     public final String site;
     public final User user;
+    public final Map<String, Object> responseFormat;
 
     @Override
     public boolean equals(final Object o) {
@@ -122,6 +123,7 @@ private CompletionsForm(final Builder builder) {
         }
         this.model = UtilMethods.isSet(builder.model) ? builder.model : ConfigService.INSTANCE.config().getModel().getCurrentModel();
         this.user = builder.user;
+        this.responseFormat = builder.responseFormat;
     }
 
     private String validateBuilderQuery(final String query) {
@@ -153,7 +155,8 @@ public static Builder copy(final CompletionsForm form) {
                 .indexName(form.indexName)
                 .threshold(form.threshold)
                 .stream(form.stream)
-                .user(form.user);
+                .user(form.user)
+                .responseFormat(form.responseFormat);
     }
 
     public static final class Builder {
@@ -188,6 +191,8 @@ public static final class Builder {
         private String site;
         @JsonSetter(nulls = Nulls.SKIP)
         private User user;
+        @JsonSetter(nulls = Nulls.SKIP)
+        private Map<String, Object> responseFormat;
 
         public Builder prompt(String queryOrPrompt) {
             this.prompt = queryOrPrompt;
@@ -269,6 +274,11 @@ public Builder user(User user) {
             return this;
         }
 
+        public Builder responseFormat(Map<String, Object> responseFormat) {
+            this.responseFormat = responseFormat;
+            return this;
+        }
+
         public CompletionsForm build() {
             return new CompletionsForm(this);
         }