feat: add confidence scores for structured extract (box/box-openapi#582) (#1379)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "f9e2519", "specHash": "f8fb08c", "version": "10.3.0" }
+{ "engineHash": "f9e2519", "specHash": "ccdb456", "version": "10.3.0" }

BoxSdkGen/Sources/Schemas/AiExtractStructured/AiExtractStructured.swift

@@ -6,6 +6,7 @@ public class AiExtractStructured: Codable, RawJSONReadable {
         case items
         case metadataTemplate = "metadata_template"
         case fields
+        case includeConfidenceScore = "include_confidence_score"
         case aiAgent = "ai_agent"
     }
 
@@ -29,6 +30,9 @@ public class AiExtractStructured: Codable, RawJSONReadable {
     /// For your request to work, you must provide either `metadata_template` or `fields`, but not both.
     public let fields: [AiExtractStructuredFieldsField]?
 
+    /// A flag to indicate whether confidence scores for every extracted field should be returned.
+    public let includeConfidenceScore: Bool?
+
     public let aiAgent: AiExtractStructuredAgent?
 
     /// Initializer for a AiExtractStructured.
@@ -39,11 +43,13 @@ public class AiExtractStructured: Codable, RawJSONReadable {
     ///     For your request to work, you must provide either `metadata_template` or `fields`, but not both.
     ///   - fields: The fields to be extracted from the provided items.
     ///     For your request to work, you must provide either `metadata_template` or `fields`, but not both.
+    ///   - includeConfidenceScore: A flag to indicate whether confidence scores for every extracted field should be returned.
     ///   - aiAgent: 
-    public init(items: [AiItemBase], metadataTemplate: AiExtractStructuredMetadataTemplateField? = nil, fields: [AiExtractStructuredFieldsField]? = nil, aiAgent: AiExtractStructuredAgent? = nil) {
+    public init(items: [AiItemBase], metadataTemplate: AiExtractStructuredMetadataTemplateField? = nil, fields: [AiExtractStructuredFieldsField]? = nil, includeConfidenceScore: Bool? = nil, aiAgent: AiExtractStructuredAgent? = nil) {
         self.items = items
         self.metadataTemplate = metadataTemplate
         self.fields = fields
+        self.includeConfidenceScore = includeConfidenceScore
         self.aiAgent = aiAgent
     }
 
@@ -52,6 +58,7 @@ public class AiExtractStructured: Codable, RawJSONReadable {
         items = try container.decode([AiItemBase].self, forKey: .items)
         metadataTemplate = try container.decodeIfPresent(AiExtractStructuredMetadataTemplateField.self, forKey: .metadataTemplate)
         fields = try container.decodeIfPresent([AiExtractStructuredFieldsField].self, forKey: .fields)
+        includeConfidenceScore = try container.decodeIfPresent(Bool.self, forKey: .includeConfidenceScore)
         aiAgent = try container.decodeIfPresent(AiExtractStructuredAgent.self, forKey: .aiAgent)
     }
 
@@ -60,6 +67,7 @@ public class AiExtractStructured: Codable, RawJSONReadable {
         try container.encode(items, forKey: .items)
         try container.encodeIfPresent(metadataTemplate, forKey: .metadataTemplate)
         try container.encodeIfPresent(fields, forKey: .fields)
+        try container.encodeIfPresent(includeConfidenceScore, forKey: .includeConfidenceScore)
         try container.encodeIfPresent(aiAgent, forKey: .aiAgent)
     }
 

BoxSdkGen/Sources/Schemas/AiExtractStructuredResponse/AiExtractStructuredResponse.swift

@@ -6,6 +6,7 @@ public class AiExtractStructuredResponse: Codable, RawJSONReadable {
         case answer
         case createdAt = "created_at"
         case completionReason = "completion_reason"
+        case confidenceScore = "confidence_score"
         case aiAgentInfo = "ai_agent_info"
     }
 
@@ -26,6 +27,9 @@ public class AiExtractStructuredResponse: Codable, RawJSONReadable {
     /// The reason the response finishes.
     public let completionReason: String?
 
+    /// The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.
+    public let confidenceScore: [String: AnyCodable]?
+
     public let aiAgentInfo: AiAgentInfo?
 
     /// Initializer for a AiExtractStructuredResponse.
@@ -34,11 +38,13 @@ public class AiExtractStructuredResponse: Codable, RawJSONReadable {
     ///   - answer: 
     ///   - createdAt: The ISO date formatted timestamp of when the answer to the prompt was created.
     ///   - completionReason: The reason the response finishes.
+    ///   - confidenceScore: The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted.
     ///   - aiAgentInfo: 
-    public init(answer: AiExtractResponse, createdAt: Date, completionReason: String? = nil, aiAgentInfo: AiAgentInfo? = nil) {
+    public init(answer: AiExtractResponse, createdAt: Date, completionReason: String? = nil, confidenceScore: [String: AnyCodable]? = nil, aiAgentInfo: AiAgentInfo? = nil) {
         self.answer = answer
         self.createdAt = createdAt
         self.completionReason = completionReason
+        self.confidenceScore = confidenceScore
         self.aiAgentInfo = aiAgentInfo
     }
 
@@ -47,6 +53,7 @@ public class AiExtractStructuredResponse: Codable, RawJSONReadable {
         answer = try container.decode(AiExtractResponse.self, forKey: .answer)
         createdAt = try container.decodeDateTime(forKey: .createdAt)
         completionReason = try container.decodeIfPresent(String.self, forKey: .completionReason)
+        confidenceScore = try container.decodeIfPresent([String: AnyCodable].self, forKey: .confidenceScore)
         aiAgentInfo = try container.decodeIfPresent(AiAgentInfo.self, forKey: .aiAgentInfo)
     }
 
@@ -55,6 +62,7 @@ public class AiExtractStructuredResponse: Codable, RawJSONReadable {
         try container.encode(answer, forKey: .answer)
         try container.encodeDateTime(field: createdAt, forKey: .createdAt)
         try container.encodeIfPresent(completionReason, forKey: .completionReason)
+        try container.encodeIfPresent(confidenceScore, forKey: .confidenceScore)
         try container.encodeIfPresent(aiAgentInfo, forKey: .aiAgentInfo)
     }