feat: Add aiAgent info to AiResponse (box/box-openapi#485) (#93)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "f073ce3", "specHash": "544d370", "version": "0.2.0" }
+{ "engineHash": "a839036", "specHash": "d7dfe68", "version": "0.2.0" }

docs/ai.md

@@ -103,7 +103,8 @@ The response depends on the agent configuration requested in this endpoint.
 ## Extract metadata (freeform)
 
 Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
-Freeform metadata extraction does not require any metadata template setup before sending the request.
+In this request, both the prompt and the output can be freeform.
+Metadata template setup before sending the request is not required.
 
 This operation is performed by calling function `createAiExtract`.
 
@@ -133,7 +134,8 @@ A response including the answer from the LLM.
 ## Extract metadata (structured)
 
 Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
-For this request, you need to use an already defined metadata template or a define a schema yourself.
+For this request, you either need a metadata template or a list of fields you want to extract.
+Input is **either** a metadata template or a list of fields to ensure the structure.
 To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
 or use the [metadata template API](g://metadata/templates/create).
 

src/main/java/com/box/sdkgen/schemas/aiagentinfo/AiAgentInfo.java

@@ -0,0 +1,81 @@
+package com.box.sdkgen.schemas.aiagentinfo;
+
+import com.box.sdkgen.internal.SerializableObject;
+import java.util.List;
+import java.util.Objects;
+
+public class AiAgentInfo extends SerializableObject {
+
+  protected List<AiAgentInfoModelsField> models;
+
+  protected String processor;
+
+  public AiAgentInfo() {
+    super();
+  }
+
+  protected AiAgentInfo(AiAgentInfoBuilder builder) {
+    super();
+    this.models = builder.models;
+    this.processor = builder.processor;
+  }
+
+  public List<AiAgentInfoModelsField> getModels() {
+    return models;
+  }
+
+  public String getProcessor() {
+    return processor;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    AiAgentInfo casted = (AiAgentInfo) o;
+    return Objects.equals(models, casted.models) && Objects.equals(processor, casted.processor);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(models, processor);
+  }
+
+  @Override
+  public String toString() {
+    return "AiAgentInfo{"
+        + "models='"
+        + models
+        + '\''
+        + ", "
+        + "processor='"
+        + processor
+        + '\''
+        + "}";
+  }
+
+  public static class AiAgentInfoBuilder {
+
+    protected List<AiAgentInfoModelsField> models;
+
+    protected String processor;
+
+    public AiAgentInfoBuilder models(List<AiAgentInfoModelsField> models) {
+      this.models = models;
+      return this;
+    }
+
+    public AiAgentInfoBuilder processor(String processor) {
+      this.processor = processor;
+      return this;
+    }
+
+    public AiAgentInfo build() {
+      return new AiAgentInfo(this);
+    }
+  }
+}

src/main/java/com/box/sdkgen/schemas/aiagentinfo/AiAgentInfoModelsField.java

@@ -0,0 +1,102 @@
+package com.box.sdkgen.schemas.aiagentinfo;
+
+import com.box.sdkgen.internal.SerializableObject;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+public class AiAgentInfoModelsField extends SerializableObject {
+
+  protected String name;
+
+  protected String provider;
+
+  @JsonProperty("supported_purpose")
+  protected String supportedPurpose;
+
+  public AiAgentInfoModelsField() {
+    super();
+  }
+
+  protected AiAgentInfoModelsField(AiAgentInfoModelsFieldBuilder builder) {
+    super();
+    this.name = builder.name;
+    this.provider = builder.provider;
+    this.supportedPurpose = builder.supportedPurpose;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public String getProvider() {
+    return provider;
+  }
+
+  public String getSupportedPurpose() {
+    return supportedPurpose;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    AiAgentInfoModelsField casted = (AiAgentInfoModelsField) o;
+    return Objects.equals(name, casted.name)
+        && Objects.equals(provider, casted.provider)
+        && Objects.equals(supportedPurpose, casted.supportedPurpose);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(name, provider, supportedPurpose);
+  }
+
+  @Override
+  public String toString() {
+    return "AiAgentInfoModelsField{"
+        + "name='"
+        + name
+        + '\''
+        + ", "
+        + "provider='"
+        + provider
+        + '\''
+        + ", "
+        + "supportedPurpose='"
+        + supportedPurpose
+        + '\''
+        + "}";
+  }
+
+  public static class AiAgentInfoModelsFieldBuilder {
+
+    protected String name;
+
+    protected String provider;
+
+    protected String supportedPurpose;
+
+    public AiAgentInfoModelsFieldBuilder name(String name) {
+      this.name = name;
+      return this;
+    }
+
+    public AiAgentInfoModelsFieldBuilder provider(String provider) {
+      this.provider = provider;
+      return this;
+    }
+
+    public AiAgentInfoModelsFieldBuilder supportedPurpose(String supportedPurpose) {
+      this.supportedPurpose = supportedPurpose;
+      return this;
+    }
+
+    public AiAgentInfoModelsField build() {
+      return new AiAgentInfoModelsField(this);
+    }
+  }
+}

src/main/java/com/box/sdkgen/schemas/airesponse/AiResponse.java

@@ -1,6 +1,7 @@
 package com.box.sdkgen.schemas.airesponse;
 
 import com.box.sdkgen.internal.SerializableObject;
+import com.box.sdkgen.schemas.aiagentinfo.AiAgentInfo;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.Objects;
 
@@ -14,6 +15,9 @@ public class AiResponse extends SerializableObject {
   @JsonProperty("completion_reason")
   protected String completionReason;
 
+  @JsonProperty("ai_agent_info")
+  protected AiAgentInfo aiAgentInfo;
+
   public AiResponse(
       @JsonProperty("answer") String answer, @JsonProperty("created_at") String createdAt) {
     super();
@@ -26,6 +30,7 @@ protected AiResponse(AiResponseBuilder builder) {
     this.answer = builder.answer;
     this.createdAt = builder.createdAt;
     this.completionReason = builder.completionReason;
+    this.aiAgentInfo = builder.aiAgentInfo;
   }
 
   public String getAnswer() {
@@ -40,6 +45,10 @@ public String getCompletionReason() {
     return completionReason;
   }
 
+  public AiAgentInfo getAiAgentInfo() {
+    return aiAgentInfo;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -51,12 +60,13 @@ public boolean equals(Object o) {
     AiResponse casted = (AiResponse) o;
     return Objects.equals(answer, casted.answer)
         && Objects.equals(createdAt, casted.createdAt)
-        && Objects.equals(completionReason, casted.completionReason);
+        && Objects.equals(completionReason, casted.completionReason)
+        && Objects.equals(aiAgentInfo, casted.aiAgentInfo);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(answer, createdAt, completionReason);
+    return Objects.hash(answer, createdAt, completionReason, aiAgentInfo);
   }
 
   @Override
@@ -73,6 +83,10 @@ public String toString() {
         + "completionReason='"
         + completionReason
         + '\''
+        + ", "
+        + "aiAgentInfo='"
+        + aiAgentInfo
+        + '\''
         + "}";
   }
 
@@ -84,6 +98,8 @@ public static class AiResponseBuilder {
 
     protected String completionReason;
 
+    protected AiAgentInfo aiAgentInfo;
+
     public AiResponseBuilder(String answer, String createdAt) {
       this.answer = answer;
       this.createdAt = createdAt;
@@ -94,6 +110,11 @@ public AiResponseBuilder completionReason(String completionReason) {
       return this;
     }
 
+    public AiResponseBuilder aiAgentInfo(AiAgentInfo aiAgentInfo) {
+      this.aiAgentInfo = aiAgentInfo;
+      return this;
+    }
+
     public AiResponse build() {
       return new AiResponse(this);
     }

src/main/java/com/box/sdkgen/schemas/airesponsefull/AiResponseFull.java

@@ -1,5 +1,6 @@
 package com.box.sdkgen.schemas.airesponsefull;
 
+import com.box.sdkgen.schemas.aiagentinfo.AiAgentInfo;
 import com.box.sdkgen.schemas.aicitation.AiCitation;
 import com.box.sdkgen.schemas.airesponse.AiResponse;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -36,12 +37,13 @@ public boolean equals(Object o) {
     return Objects.equals(answer, casted.answer)
         && Objects.equals(createdAt, casted.createdAt)
         && Objects.equals(completionReason, casted.completionReason)
+        && Objects.equals(aiAgentInfo, casted.aiAgentInfo)
         && Objects.equals(citations, casted.citations);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(answer, createdAt, completionReason, citations);
+    return Objects.hash(answer, createdAt, completionReason, aiAgentInfo, citations);
   }
 
   @Override
@@ -59,6 +61,10 @@ public String toString() {
         + completionReason
         + '\''
         + ", "
+        + "aiAgentInfo='"
+        + aiAgentInfo
+        + '\''
+        + ", "
         + "citations='"
         + citations
         + '\''
@@ -84,6 +90,12 @@ public AiResponseFullBuilder completionReason(String completionReason) {
       return this;
     }
 
+    @Override
+    public AiResponseFullBuilder aiAgentInfo(AiAgentInfo aiAgentInfo) {
+      this.aiAgentInfo = aiAgentInfo;
+      return this;
+    }
+
     public AiResponseFull build() {
       return new AiResponseFull(this);
     }