Releasing version 2.112.0

Releasing version 2.112.0

Author: oci-dex-release-bot

lib/aidocument/lib/client.ts

@@ -1277,6 +1277,79 @@ export class AIServiceDocumentClient {
     }
   }
 
+  /**
+   * Gets model capabilities
+   * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+   * @param GetModelTypeRequest
+   * @return GetModelTypeResponse
+   * @throws OciError when an error occurs
+   * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/aidocument/GetModelType.ts.html |here} to see how to use GetModelType API.
+   */
+  public async getModelType(
+    getModelTypeRequest: requests.GetModelTypeRequest
+  ): Promise<responses.GetModelTypeResponse> {
+    if (this.logger) this.logger.debug("Calling operation AIServiceDocumentClient#getModelType.");
+    const operationName = "getModelType";
+    const apiReferenceLink = "";
+    const pathParams = {
+      "{modelType}": getModelTypeRequest.modelType
+    };
+
+    const queryParams = {
+      "compartmentId": getModelTypeRequest.compartmentId,
+      "modelSubType": getModelTypeRequest.modelSubType
+    };
+
+    let headerParams = {
+      "Content-Type": common.Constants.APPLICATION_JSON,
+      "opc-request-id": getModelTypeRequest.opcRequestId
+    };
+
+    const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+    const retrier = GenericRetrier.createPreferredRetrier(
+      this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined,
+      getModelTypeRequest.retryConfiguration,
+      specRetryConfiguration
+    );
+    if (this.logger) retrier.logger = this.logger;
+    const request = await composeRequest({
+      baseEndpoint: this._endpoint,
+      defaultHeaders: this._defaultHeaders,
+      path: "/modelTypes/{modelType}",
+      method: "GET",
+      pathParams: pathParams,
+      headerParams: headerParams,
+      queryParams: queryParams
+    });
+    try {
+      const response = await retrier.makeServiceCall(
+        this._httpClient,
+        request,
+        this.targetService,
+        operationName,
+        apiReferenceLink
+      );
+      const sdkResponse = composeResponse({
+        responseObject: <responses.GetModelTypeResponse>{},
+        body: await response.json(),
+        bodyKey: "modelTypeInfo",
+        bodyModel: model.ModelTypeInfo,
+        type: "model.ModelTypeInfo",
+        responseHeaders: [
+          {
+            value: response.headers.get("opc-request-id"),
+            key: "opcRequestId",
+            dataType: "string"
+          }
+        ]
+      });
+
+      return sdkResponse;
+    } catch (err) {
+      throw err;
+    }
+  }
+
   /**
    * Get the details of a processor job.
    *

lib/aidocument/lib/model/analyze-document-result.ts

@@ -51,6 +51,14 @@ export interface AnalyzeDocumentResult {
    * The document table extraction model version.
    */
   "tableExtractionModelVersion"?: string;
+  /**
+   * The document signature extraction model version.
+   */
+  "signatureExtractionModelVersion"?: string;
+  /**
+   * The document bar code extraction model version.
+   */
+  "barCodeExtractionModelVersion"?: string;
   /**
    * The errors encountered during document analysis.
    */

lib/aidocument/lib/model/bar-code.ts

@@ -0,0 +1,61 @@
+/**
+ * Document Understanding API
+ * Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.
+ * OpenAPI spec version: 20221109
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+import * as model from "../model";
+import common = require("oci-common");
+
+/**
+ * A single bar code.
+ */
+export interface BarCode {
+  /**
+   * the confidence score between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+   */
+  "confidence": number;
+  /**
+   * the bar code value.
+   */
+  "value": string;
+  /**
+   * the encoding schema of bar code.
+   */
+  "codeType"?: string;
+  "boundingPolygon": model.BoundingPolygon;
+}
+
+export namespace BarCode {
+  export function getJsonObj(obj: BarCode): object {
+    const jsonObj = {
+      ...obj,
+      ...{
+        "boundingPolygon": obj.boundingPolygon
+          ? model.BoundingPolygon.getJsonObj(obj.boundingPolygon)
+          : undefined
+      }
+    };
+
+    return jsonObj;
+  }
+  export function getDeserializedJsonObj(obj: BarCode): object {
+    const jsonObj = {
+      ...obj,
+      ...{
+        "boundingPolygon": obj.boundingPolygon
+          ? model.BoundingPolygon.getDeserializedJsonObj(obj.boundingPolygon)
+          : undefined
+      }
+    };
+
+    return jsonObj;
+  }
+}

lib/aidocument/lib/model/capabilities.ts

@@ -0,0 +1,52 @@
+/**
+ * Document Understanding API
+ * Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.
+ * OpenAPI spec version: 20221109
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+import * as model from "../model";
+import common = require("oci-common");
+
+/**
+ * Capabilities supported
+ */
+export interface Capabilities {
+  /**
+   * Model information capabilities related to version
+   */
+  "capability"?: { [key: string]: model.Capability };
+}
+
+export namespace Capabilities {
+  export function getJsonObj(obj: Capabilities): object {
+    const jsonObj = {
+      ...obj,
+      ...{
+        "capability": obj.capability
+          ? common.mapContainer(obj.capability, model.Capability.getJsonObj)
+          : undefined
+      }
+    };
+
+    return jsonObj;
+  }
+  export function getDeserializedJsonObj(obj: Capabilities): object {
+    const jsonObj = {
+      ...obj,
+      ...{
+        "capability": obj.capability
+          ? common.mapContainer(obj.capability, model.Capability.getDeserializedJsonObj)
+          : undefined
+      }
+    };
+
+    return jsonObj;
+  }
+}

lib/aidocument/lib/model/capability.ts

@@ -0,0 +1,38 @@
+/**
+ * Document Understanding API
+ * Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.
+ * OpenAPI spec version: 20221109
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+import * as model from "../model";
+import common = require("oci-common");
+
+/**
+ * Capability supported
+ */
+export interface Capability {
+  /**
+   * values
+   */
+  "details"?: Array<string>;
+}
+
+export namespace Capability {
+  export function getJsonObj(obj: Capability): object {
+    const jsonObj = { ...obj, ...{} };
+
+    return jsonObj;
+  }
+  export function getDeserializedJsonObj(obj: Capability): object {
+    const jsonObj = { ...obj, ...{} };
+
+    return jsonObj;
+  }
+}

lib/aidocument/lib/model/create-model-details.ts

@@ -34,6 +34,14 @@ export interface CreateModelDetails {
    * The type of the Document model.
    */
   "modelType": string;
+  /**
+   * Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.
+   */
+  "modelSubType"?: model.KvModelSubType | model.DocumentElementsSubType;
+  /**
+   * Number of replicas required for this model. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+   */
+  "inferenceUnits"?: number;
   /**
    * The compartment identifier.
    */
@@ -46,6 +54,10 @@ export interface CreateModelDetails {
    * The maximum model training time in hours, expressed as a decimal fraction. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
    */
   "maxTrainingTimeInHours"?: number;
+  /**
+   * The document language for model training, abbreviated according to the BCP 47 syntax.
+   */
+  "language"?: string;
   "trainingDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
   "testingDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
   "validationDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
@@ -80,6 +92,10 @@ export namespace CreateModelDetails {
     const jsonObj = {
       ...obj,
       ...{
+        "modelSubType": obj.modelSubType
+          ? model.ModelSubType.getJsonObj(obj.modelSubType)
+          : undefined,
+
         "trainingDataset": obj.trainingDataset
           ? model.Dataset.getJsonObj(obj.trainingDataset)
           : undefined,
@@ -103,6 +119,10 @@ export namespace CreateModelDetails {
     const jsonObj = {
       ...obj,
       ...{
+        "modelSubType": obj.modelSubType
+          ? model.ModelSubType.getDeserializedJsonObj(obj.modelSubType)
+          : undefined,
+
         "trainingDataset": obj.trainingDataset
           ? model.Dataset.getDeserializedJsonObj(obj.trainingDataset)
           : undefined,

lib/aidocument/lib/model/create-processor-job-details.ts

@@ -28,7 +28,7 @@ export interface CreateProcessorJobDetails {
    * The display name of the processor job.
    */
   "displayName"?: string;
-  "processorConfig": model.GeneralProcessorConfig;
+  "processorConfig": model.InvoiceProcessorConfig | model.GeneralProcessorConfig;
 }
 
 export namespace CreateProcessorJobDetails {

lib/aidocument/lib/model/detected-document-type.ts

@@ -22,6 +22,10 @@ export interface DetectedDocumentType {
    * The document type.
    */
   "documentType": string;
+  /**
+   * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Key-Value Extraction model that was used to extract the key-value pairs.
+   */
+  "documentId"?: string;
   /**
    * The confidence score between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
    */

lib/aidocument/lib/model/document-classification-feature.ts

@@ -23,9 +23,13 @@ export interface DocumentClassificationFeature extends model.DocumentFeature {
    */
   "maxResults"?: number;
   /**
-   * The custom model ID.
+   * Unique identifier custom model OCID that should be used for inference.
    */
   "modelId"?: string;
+  /**
+   * The custom model tenancy ID when modelId represents aliasName.
+   */
+  "tenancyId"?: string;
 
   "featureType": string;
 }

lib/aidocument/lib/model/document-elements-extraction-feature.ts

@@ -0,0 +1,57 @@
+/**
+ * Document Understanding API
+ * Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.
+ * OpenAPI spec version: 20221109
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+import * as model from "../model";
+import common = require("oci-common");
+
+/**
+ * Extract information from bar code
+ */
+export interface DocumentElementsExtractionFeature extends model.DocumentFeature {
+  /**
+   * Unique identifier custom model OCID that should be used for inference.
+   */
+  "modelId"?: string;
+
+  "featureType": string;
+}
+
+export namespace DocumentElementsExtractionFeature {
+  export function getJsonObj(
+    obj: DocumentElementsExtractionFeature,
+    isParentJsonObj?: boolean
+  ): object {
+    const jsonObj = {
+      ...(isParentJsonObj
+        ? obj
+        : (model.DocumentFeature.getJsonObj(obj) as DocumentElementsExtractionFeature)),
+      ...{}
+    };
+
+    return jsonObj;
+  }
+  export const featureType = "DOCUMENT_ELEMENTS_EXTRACTION";
+  export function getDeserializedJsonObj(
+    obj: DocumentElementsExtractionFeature,
+    isParentJsonObj?: boolean
+  ): object {
+    const jsonObj = {
+      ...(isParentJsonObj
+        ? obj
+        : (model.DocumentFeature.getDeserializedJsonObj(obj) as DocumentElementsExtractionFeature)),
+      ...{}
+    };
+
+    return jsonObj;
+  }
+}