oci 2.154.3__py3-none-any.whl → 2.155.1__py3-none-any.whl

oci/ai_document/models/bar_code.py

@@ -0,0 +1,159 @@
+# coding: utf-8
+# Copyright (c) 2016, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20221109
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class BarCode(object):
+    """
+    A single bar code.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BarCode object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param confidence:
+            The value to assign to the confidence property of this BarCode.
+        :type confidence: float
+
+        :param value:
+            The value to assign to the value property of this BarCode.
+        :type value: str
+
+        :param code_type:
+            The value to assign to the code_type property of this BarCode.
+        :type code_type: str
+
+        :param bounding_polygon:
+            The value to assign to the bounding_polygon property of this BarCode.
+        :type bounding_polygon: oci.ai_document.models.BoundingPolygon
+
+        """
+        self.swagger_types = {
+            'confidence': 'float',
+            'value': 'str',
+            'code_type': 'str',
+            'bounding_polygon': 'BoundingPolygon'
+        }
+        self.attribute_map = {
+            'confidence': 'confidence',
+            'value': 'value',
+            'code_type': 'codeType',
+            'bounding_polygon': 'boundingPolygon'
+        }
+        self._confidence = None
+        self._value = None
+        self._code_type = None
+        self._bounding_polygon = None
+
+    @property
+    def confidence(self):
+        """
+        **[Required]** Gets the confidence of this BarCode.
+        the confidence score between 0 and 1.
+
+
+        :return: The confidence of this BarCode.
+        :rtype: float
+        """
+        return self._confidence
+
+    @confidence.setter
+    def confidence(self, confidence):
+        """
+        Sets the confidence of this BarCode.
+        the confidence score between 0 and 1.
+
+
+        :param confidence: The confidence of this BarCode.
+        :type: float
+        """
+        self._confidence = confidence
+
+    @property
+    def value(self):
+        """
+        **[Required]** Gets the value of this BarCode.
+        the bar code value.
+
+
+        :return: The value of this BarCode.
+        :rtype: str
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        """
+        Sets the value of this BarCode.
+        the bar code value.
+
+
+        :param value: The value of this BarCode.
+        :type: str
+        """
+        self._value = value
+
+    @property
+    def code_type(self):
+        """
+        Gets the code_type of this BarCode.
+        the encoding schema of bar code.
+
+
+        :return: The code_type of this BarCode.
+        :rtype: str
+        """
+        return self._code_type
+
+    @code_type.setter
+    def code_type(self, code_type):
+        """
+        Sets the code_type of this BarCode.
+        the encoding schema of bar code.
+
+
+        :param code_type: The code_type of this BarCode.
+        :type: str
+        """
+        self._code_type = code_type
+
+    @property
+    def bounding_polygon(self):
+        """
+        **[Required]** Gets the bounding_polygon of this BarCode.
+
+        :return: The bounding_polygon of this BarCode.
+        :rtype: oci.ai_document.models.BoundingPolygon
+        """
+        return self._bounding_polygon
+
+    @bounding_polygon.setter
+    def bounding_polygon(self, bounding_polygon):
+        """
+        Sets the bounding_polygon of this BarCode.
+
+        :param bounding_polygon: The bounding_polygon of this BarCode.
+        :type: oci.ai_document.models.BoundingPolygon
+        """
+        self._bounding_polygon = bounding_polygon
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_document/models/capabilities.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2016, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20221109
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class Capabilities(object):
+    """
+    Capabilities supported
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Capabilities object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param capability:
+            The value to assign to the capability property of this Capabilities.
+        :type capability: dict(str, Capability)
+
+        """
+        self.swagger_types = {
+            'capability': 'dict(str, Capability)'
+        }
+        self.attribute_map = {
+            'capability': 'capability'
+        }
+        self._capability = None
+
+    @property
+    def capability(self):
+        """
+        Gets the capability of this Capabilities.
+        Model information capabilities related to version
+
+
+        :return: The capability of this Capabilities.
+        :rtype: dict(str, Capability)
+        """
+        return self._capability
+
+    @capability.setter
+    def capability(self, capability):
+        """
+        Sets the capability of this Capabilities.
+        Model information capabilities related to version
+
+
+        :param capability: The capability of this Capabilities.
+        :type: dict(str, Capability)
+        """
+        self._capability = capability
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_document/models/capability.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2016, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20221109
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class Capability(object):
+    """
+    Capability supported
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Capability object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param details:
+            The value to assign to the details property of this Capability.
+        :type details: list[str]
+
+        """
+        self.swagger_types = {
+            'details': 'list[str]'
+        }
+        self.attribute_map = {
+            'details': 'details'
+        }
+        self._details = None
+
+    @property
+    def details(self):
+        """
+        Gets the details of this Capability.
+        values
+
+
+        :return: The details of this Capability.
+        :rtype: list[str]
+        """
+        return self._details
+
+    @details.setter
+    def details(self, details):
+        """
+        Sets the details of this Capability.
+        values
+
+
+        :param details: The details of this Capability.
+        :type: list[str]
+        """
+        self._details = details
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_document/models/create_model_details.py

@@ -36,6 +36,14 @@ class CreateModelDetails(object):
             The value to assign to the model_type property of this CreateModelDetails.
         :type model_type: str
 
+        :param model_sub_type:
+            The value to assign to the model_sub_type property of this CreateModelDetails.
+        :type model_sub_type: oci.ai_document.models.ModelSubType
+
+        :param inference_units:
+            The value to assign to the inference_units property of this CreateModelDetails.
+        :type inference_units: int
+
         :param compartment_id:
             The value to assign to the compartment_id property of this CreateModelDetails.
         :type compartment_id: str
@@ -48,6 +56,10 @@ class CreateModelDetails(object):
             The value to assign to the max_training_time_in_hours property of this CreateModelDetails.
         :type max_training_time_in_hours: float
 
+        :param language:
+            The value to assign to the language property of this CreateModelDetails.
+        :type language: str
+
         :param training_dataset:
             The value to assign to the training_dataset property of this CreateModelDetails.
         :type training_dataset: oci.ai_document.models.Dataset
@@ -86,9 +98,12 @@ class CreateModelDetails(object):
             'description': 'str',
             'model_version': 'str',
             'model_type': 'str',
+            'model_sub_type': 'ModelSubType',
+            'inference_units': 'int',
             'compartment_id': 'str',
             'is_quick_mode': 'bool',
             'max_training_time_in_hours': 'float',
+            'language': 'str',
             'training_dataset': 'Dataset',
             'testing_dataset': 'Dataset',
             'validation_dataset': 'Dataset',
@@ -103,9 +118,12 @@ class CreateModelDetails(object):
             'description': 'description',
             'model_version': 'modelVersion',
             'model_type': 'modelType',
+            'model_sub_type': 'modelSubType',
+            'inference_units': 'inferenceUnits',
             'compartment_id': 'compartmentId',
             'is_quick_mode': 'isQuickMode',
             'max_training_time_in_hours': 'maxTrainingTimeInHours',
+            'language': 'language',
             'training_dataset': 'trainingDataset',
             'testing_dataset': 'testingDataset',
             'validation_dataset': 'validationDataset',
@@ -119,9 +137,12 @@ class CreateModelDetails(object):
         self._description = None
         self._model_version = None
         self._model_type = None
+        self._model_sub_type = None
+        self._inference_units = None
         self._compartment_id = None
         self._is_quick_mode = None
         self._max_training_time_in_hours = None
+        self._language = None
         self._training_dataset = None
         self._testing_dataset = None
         self._validation_dataset = None
@@ -227,6 +248,54 @@ class CreateModelDetails(object):
         """
         self._model_type = model_type
 
+    @property
+    def model_sub_type(self):
+        """
+        Gets the model_sub_type of this CreateModelDetails.
+        Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.
+
+
+        :return: The model_sub_type of this CreateModelDetails.
+        :rtype: oci.ai_document.models.ModelSubType
+        """
+        return self._model_sub_type
+
+    @model_sub_type.setter
+    def model_sub_type(self, model_sub_type):
+        """
+        Sets the model_sub_type of this CreateModelDetails.
+        Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.
+
+
+        :param model_sub_type: The model_sub_type of this CreateModelDetails.
+        :type: oci.ai_document.models.ModelSubType
+        """
+        self._model_sub_type = model_sub_type
+
+    @property
+    def inference_units(self):
+        """
+        Gets the inference_units of this CreateModelDetails.
+        Number of replicas required for this model.
+
+
+        :return: The inference_units of this CreateModelDetails.
+        :rtype: int
+        """
+        return self._inference_units
+
+    @inference_units.setter
+    def inference_units(self, inference_units):
+        """
+        Sets the inference_units of this CreateModelDetails.
+        Number of replicas required for this model.
+
+
+        :param inference_units: The inference_units of this CreateModelDetails.
+        :type: int
+        """
+        self._inference_units = inference_units
+
     @property
     def compartment_id(self):
         """
@@ -299,6 +368,30 @@ class CreateModelDetails(object):
         """
         self._max_training_time_in_hours = max_training_time_in_hours
 
+    @property
+    def language(self):
+        """
+        Gets the language of this CreateModelDetails.
+        The document language for model training, abbreviated according to the BCP 47 syntax.
+
+
+        :return: The language of this CreateModelDetails.
+        :rtype: str
+        """
+        return self._language
+
+    @language.setter
+    def language(self, language):
+        """
+        Sets the language of this CreateModelDetails.
+        The document language for model training, abbreviated according to the BCP 47 syntax.
+
+
+        :param language: The language of this CreateModelDetails.
+        :type: str
+        """
+        self._language = language
+
     @property
     def training_dataset(self):
         """

oci/ai_document/models/detected_document_type.py

@@ -24,6 +24,10 @@ class DetectedDocumentType(object):
             The value to assign to the document_type property of this DetectedDocumentType.
         :type document_type: str
 
+        :param document_id:
+            The value to assign to the document_id property of this DetectedDocumentType.
+        :type document_id: str
+
         :param confidence:
             The value to assign to the confidence property of this DetectedDocumentType.
         :type confidence: float
@@ -31,13 +35,16 @@ class DetectedDocumentType(object):
         """
         self.swagger_types = {
             'document_type': 'str',
+            'document_id': 'str',
             'confidence': 'float'
         }
         self.attribute_map = {
             'document_type': 'documentType',
+            'document_id': 'documentId',
             'confidence': 'confidence'
         }
         self._document_type = None
+        self._document_id = None
         self._confidence = None
 
     @property
@@ -64,6 +71,34 @@ class DetectedDocumentType(object):
         """
         self._document_type = document_type
 
+    @property
+    def document_id(self):
+        """
+        Gets the document_id of this DetectedDocumentType.
+        The `OCID`__ of the Key-Value Extraction model that was used to extract the key-value pairs.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The document_id of this DetectedDocumentType.
+        :rtype: str
+        """
+        return self._document_id
+
+    @document_id.setter
+    def document_id(self, document_id):
+        """
+        Sets the document_id of this DetectedDocumentType.
+        The `OCID`__ of the Key-Value Extraction model that was used to extract the key-value pairs.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param document_id: The document_id of this DetectedDocumentType.
+        :type: str
+        """
+        self._document_id = document_id
+
     @property
     def confidence(self):
         """

oci/ai_document/models/document_classification_feature.py

@@ -23,7 +23,7 @@ class DocumentClassificationFeature(DocumentFeature):
 
         :param feature_type:
             The value to assign to the feature_type property of this DocumentClassificationFeature.
-            Allowed values for this property are: "LANGUAGE_CLASSIFICATION", "TEXT_EXTRACTION", "TABLE_EXTRACTION", "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION"
+            Allowed values for this property are: "LANGUAGE_CLASSIFICATION", "TEXT_EXTRACTION", "TABLE_EXTRACTION", "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION", "DOCUMENT_ELEMENTS_EXTRACTION"
         :type feature_type: str
 
         :param max_results:
@@ -34,20 +34,27 @@ class DocumentClassificationFeature(DocumentFeature):
             The value to assign to the model_id property of this DocumentClassificationFeature.
         :type model_id: str
 
+        :param tenancy_id:
+            The value to assign to the tenancy_id property of this DocumentClassificationFeature.
+        :type tenancy_id: str
+
         """
         self.swagger_types = {
             'feature_type': 'str',
             'max_results': 'int',
-            'model_id': 'str'
+            'model_id': 'str',
+            'tenancy_id': 'str'
         }
         self.attribute_map = {
             'feature_type': 'featureType',
             'max_results': 'maxResults',
-            'model_id': 'modelId'
+            'model_id': 'modelId',
+            'tenancy_id': 'tenancyId'
         }
         self._feature_type = None
         self._max_results = None
         self._model_id = None
+        self._tenancy_id = None
         self._feature_type = 'DOCUMENT_CLASSIFICATION'
 
     @property
@@ -78,7 +85,7 @@ class DocumentClassificationFeature(DocumentFeature):
     def model_id(self):
         """
         Gets the model_id of this DocumentClassificationFeature.
-        The custom model ID.
+        Unique identifier custom model OCID that should be used for inference.
 
 
         :return: The model_id of this DocumentClassificationFeature.
@@ -90,7 +97,7 @@ class DocumentClassificationFeature(DocumentFeature):
     def model_id(self, model_id):
         """
         Sets the model_id of this DocumentClassificationFeature.
-        The custom model ID.
+        Unique identifier custom model OCID that should be used for inference.
 
 
         :param model_id: The model_id of this DocumentClassificationFeature.
@@ -98,6 +105,30 @@ class DocumentClassificationFeature(DocumentFeature):
         """
         self._model_id = model_id
 
+    @property
+    def tenancy_id(self):
+        """
+        Gets the tenancy_id of this DocumentClassificationFeature.
+        The custom model tenancy ID when modelId represents aliasName.
+
+
+        :return: The tenancy_id of this DocumentClassificationFeature.
+        :rtype: str
+        """
+        return self._tenancy_id
+
+    @tenancy_id.setter
+    def tenancy_id(self, tenancy_id):
+        """
+        Sets the tenancy_id of this DocumentClassificationFeature.
+        The custom model tenancy ID when modelId represents aliasName.
+
+
+        :param tenancy_id: The tenancy_id of this DocumentClassificationFeature.
+        :type: str
+        """
+        self._tenancy_id = tenancy_id
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/ai_document/models/document_classification_model_metrics.py

@@ -23,7 +23,7 @@ class DocumentClassificationModelMetrics(ModelMetrics):
 
         :param model_type:
             The value to assign to the model_type property of this DocumentClassificationModelMetrics.
-            Allowed values for this property are: "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION"
+            Allowed values for this property are: "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION", "PRE_TRAINED_TEXT_EXTRACTION", "PRE_TRAINED_TABLE_EXTRACTION", "PRE_TRAINED_KEY_VALUE_EXTRACTION", "PRE_TRAINED_DOCUMENT_CLASSIFICATION", "PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION"
         :type model_type: str
 
         :param dataset_summary:

oci/ai_document/models/document_elements_extraction_feature.py

@@ -0,0 +1,80 @@
+# coding: utf-8
+# Copyright (c) 2016, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20221109
+
+from .document_feature import DocumentFeature
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class DocumentElementsExtractionFeature(DocumentFeature):
+    """
+    Extract information from bar code
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DocumentElementsExtractionFeature object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_document.models.DocumentElementsExtractionFeature.feature_type` attribute
+        of this class is ``DOCUMENT_ELEMENTS_EXTRACTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param feature_type:
+            The value to assign to the feature_type property of this DocumentElementsExtractionFeature.
+            Allowed values for this property are: "LANGUAGE_CLASSIFICATION", "TEXT_EXTRACTION", "TABLE_EXTRACTION", "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION", "DOCUMENT_ELEMENTS_EXTRACTION"
+        :type feature_type: str
+
+        :param model_id:
+            The value to assign to the model_id property of this DocumentElementsExtractionFeature.
+        :type model_id: str
+
+        """
+        self.swagger_types = {
+            'feature_type': 'str',
+            'model_id': 'str'
+        }
+        self.attribute_map = {
+            'feature_type': 'featureType',
+            'model_id': 'modelId'
+        }
+        self._feature_type = None
+        self._model_id = None
+        self._feature_type = 'DOCUMENT_ELEMENTS_EXTRACTION'
+
+    @property
+    def model_id(self):
+        """
+        Gets the model_id of this DocumentElementsExtractionFeature.
+        Unique identifier custom model OCID that should be used for inference.
+
+
+        :return: The model_id of this DocumentElementsExtractionFeature.
+        :rtype: str
+        """
+        return self._model_id
+
+    @model_id.setter
+    def model_id(self, model_id):
+        """
+        Sets the model_id of this DocumentElementsExtractionFeature.
+        Unique identifier custom model OCID that should be used for inference.
+
+
+        :param model_id: The model_id of this DocumentElementsExtractionFeature.
+        :type: str
+        """
+        self._model_id = model_id
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other