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

Author: box-sdk-build

.codegen.json

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

src/sdk-gen/schemas/aiExtractStructured.ts

@@ -75,6 +75,9 @@ export interface AiExtractStructured {
    * 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. */
   readonly fields?: readonly AiExtractStructuredFieldsField[];
+  /**
+   * A flag to indicate whether confidence scores for every extracted field should be returned. */
+  readonly includeConfidenceScore?: boolean;
   readonly aiAgent?: AiExtractStructuredAgent;
   readonly rawData?: SerializedData;
 }
@@ -282,6 +285,7 @@ export function serializeAiExtractStructured(
           ): SerializedData {
             return serializeAiExtractStructuredFieldsField(item);
           }) as readonly any[]),
+    ['include_confidence_score']: val.includeConfidenceScore,
     ['ai_agent']:
       val.aiAgent == void 0
         ? val.aiAgent
@@ -332,6 +336,19 @@ export function deserializeAiExtractStructured(
             return deserializeAiExtractStructuredFieldsField(itm);
           }) as readonly any[])
         : [];
+  if (
+    !(val.include_confidence_score == void 0) &&
+    !sdIsBoolean(val.include_confidence_score)
+  ) {
+    throw new BoxSdkError({
+      message:
+        'Expecting boolean for "include_confidence_score" of type "AiExtractStructured"',
+    });
+  }
+  const includeConfidenceScore: undefined | boolean =
+    val.include_confidence_score == void 0
+      ? void 0
+      : val.include_confidence_score;
   const aiAgent: undefined | AiExtractStructuredAgent =
     val.ai_agent == void 0
       ? void 0
@@ -340,6 +357,7 @@ export function deserializeAiExtractStructured(
     items: items,
     metadataTemplate: metadataTemplate,
     fields: fields,
+    includeConfidenceScore: includeConfidenceScore,
     aiAgent: aiAgent,
   } satisfies AiExtractStructured;
 }

src/sdk-gen/schemas/aiExtractStructuredResponse.ts

@@ -23,6 +23,11 @@ export interface AiExtractStructuredResponse {
   /**
    * The reason the response finishes. */
   readonly 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. */
+  readonly confidenceScore?: {
+    readonly [key: string]: any;
+  };
   readonly aiAgentInfo?: AiAgentInfo;
   readonly rawData?: SerializedData;
 }
@@ -33,6 +38,19 @@ export function serializeAiExtractStructuredResponse(
     ['answer']: serializeAiExtractResponse(val.answer),
     ['created_at']: serializeDateTime(val.createdAt),
     ['completion_reason']: val.completionReason,
+    ['confidence_score']:
+      val.confidenceScore == void 0
+        ? val.confidenceScore
+        : (Object.fromEntries(
+            Object.entries(val.confidenceScore).map(([k, v]: [string, any]) => [
+              k,
+              (function (v: any): any {
+                return v;
+              })(v),
+            ])
+          ) as {
+            readonly [key: string]: any;
+          }),
     ['ai_agent_info']:
       val.aiAgentInfo == void 0
         ? val.aiAgentInfo
@@ -78,6 +96,33 @@ export function deserializeAiExtractStructuredResponse(
   }
   const completionReason: undefined | string =
     val.completion_reason == void 0 ? void 0 : val.completion_reason;
+  if (!(val.confidence_score == void 0) && !sdIsMap(val.confidence_score)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting object for "confidence_score" of type "AiExtractStructuredResponse"',
+    });
+  }
+  const confidenceScore:
+    | undefined
+    | {
+        readonly [key: string]: any;
+      } =
+    val.confidence_score == void 0
+      ? void 0
+      : sdIsMap(val.confidence_score)
+        ? (Object.fromEntries(
+            Object.entries(val.confidence_score).map(
+              ([k, v]: [string, any]) => [
+                k,
+                (function (v: any): any {
+                  return v;
+                })(v),
+              ]
+            )
+          ) as {
+            readonly [key: string]: any;
+          })
+        : {};
   const aiAgentInfo: undefined | AiAgentInfo =
     val.ai_agent_info == void 0
       ? void 0
@@ -86,6 +131,7 @@ export function deserializeAiExtractStructuredResponse(
     answer: answer,
     createdAt: createdAt,
     completionReason: completionReason,
+    confidenceScore: confidenceScore,
     aiAgentInfo: aiAgentInfo,
   } satisfies AiExtractStructuredResponse;
 }