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

oci/ai_document/models/health_insurance_kv_model_sub_type_details.py

@@ -0,0 +1,110 @@
+# 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 HealthInsuranceKvModelSubTypeDetails(object):
+    """
+    Health insurance card KV model sub type details
+    """
+
+    #: A constant which can be used with the model_sub_type property of a HealthInsuranceKvModelSubTypeDetails.
+    #: This constant has a value of "RECEIPT"
+    MODEL_SUB_TYPE_RECEIPT = "RECEIPT"
+
+    #: A constant which can be used with the model_sub_type property of a HealthInsuranceKvModelSubTypeDetails.
+    #: This constant has a value of "INVOICE"
+    MODEL_SUB_TYPE_INVOICE = "INVOICE"
+
+    #: A constant which can be used with the model_sub_type property of a HealthInsuranceKvModelSubTypeDetails.
+    #: This constant has a value of "PASSPORT"
+    MODEL_SUB_TYPE_PASSPORT = "PASSPORT"
+
+    #: A constant which can be used with the model_sub_type property of a HealthInsuranceKvModelSubTypeDetails.
+    #: This constant has a value of "DRIVER_LICENSE"
+    MODEL_SUB_TYPE_DRIVER_LICENSE = "DRIVER_LICENSE"
+
+    #: A constant which can be used with the model_sub_type property of a HealthInsuranceKvModelSubTypeDetails.
+    #: This constant has a value of "HEALTH_INSURANCE_ID"
+    MODEL_SUB_TYPE_HEALTH_INSURANCE_ID = "HEALTH_INSURANCE_ID"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new HealthInsuranceKvModelSubTypeDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_sub_type:
+            The value to assign to the model_sub_type property of this HealthInsuranceKvModelSubTypeDetails.
+            Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"
+        :type model_sub_type: str
+
+        """
+        self.swagger_types = {
+            'model_sub_type': 'str'
+        }
+        self.attribute_map = {
+            'model_sub_type': 'modelSubType'
+        }
+        self._model_sub_type = None
+
+    @property
+    def model_sub_type(self):
+        """
+        **[Required]** Gets the model_sub_type of this HealthInsuranceKvModelSubTypeDetails.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+        Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"
+
+
+        :return: The model_sub_type of this HealthInsuranceKvModelSubTypeDetails.
+        :rtype: str
+        """
+        return self._model_sub_type
+
+    @model_sub_type.setter
+    def model_sub_type(self, model_sub_type):
+        """
+        Sets the model_sub_type of this HealthInsuranceKvModelSubTypeDetails.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+
+        :param model_sub_type: The model_sub_type of this HealthInsuranceKvModelSubTypeDetails.
+        :type: str
+        """
+        allowed_values = ["RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"]
+        if not value_allowed_none_or_none_sentinel(model_sub_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `model_sub_type`, must be None or one of {allowed_values}"
+            )
+        self._model_sub_type = model_sub_type
+
+    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/inline_document_content.py

@@ -30,17 +30,24 @@ class InlineDocumentContent(InputLocation):
             The value to assign to the data property of this InlineDocumentContent.
         :type data: str
 
+        :param page_range:
+            The value to assign to the page_range property of this InlineDocumentContent.
+        :type page_range: list[str]
+
         """
         self.swagger_types = {
             'source_type': 'str',
-            'data': 'str'
+            'data': 'str',
+            'page_range': 'list[str]'
         }
         self.attribute_map = {
             'source_type': 'sourceType',
-            'data': 'data'
+            'data': 'data',
+            'page_range': 'pageRange'
         }
         self._source_type = None
         self._data = None
+        self._page_range = None
         self._source_type = 'INLINE_DOCUMENT_CONTENT'
 
     @property
@@ -67,6 +74,30 @@ class InlineDocumentContent(InputLocation):
         """
         self._data = data
 
+    @property
+    def page_range(self):
+        """
+        Gets the page_range of this InlineDocumentContent.
+        The page ranges to be analysed.
+
+
+        :return: The page_range of this InlineDocumentContent.
+        :rtype: list[str]
+        """
+        return self._page_range
+
+    @page_range.setter
+    def page_range(self, page_range):
+        """
+        Sets the page_range of this InlineDocumentContent.
+        The page ranges to be analysed.
+
+
+        :param page_range: The page_range of this InlineDocumentContent.
+        :type: list[str]
+        """
+        self._page_range = page_range
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/ai_document/models/inline_document_details.py

@@ -30,17 +30,24 @@ class InlineDocumentDetails(DocumentDetails):
             The value to assign to the data property of this InlineDocumentDetails.
         :type data: str
 
+        :param page_range:
+            The value to assign to the page_range property of this InlineDocumentDetails.
+        :type page_range: list[str]
+
         """
         self.swagger_types = {
             'source': 'str',
-            'data': 'str'
+            'data': 'str',
+            'page_range': 'list[str]'
         }
         self.attribute_map = {
             'source': 'source',
-            'data': 'data'
+            'data': 'data',
+            'page_range': 'pageRange'
         }
         self._source = None
         self._data = None
+        self._page_range = None
         self._source = 'INLINE'
 
     @property
@@ -67,6 +74,30 @@ class InlineDocumentDetails(DocumentDetails):
         """
         self._data = data
 
+    @property
+    def page_range(self):
+        """
+        Gets the page_range of this InlineDocumentDetails.
+        The page ranges to be analysed.
+
+
+        :return: The page_range of this InlineDocumentDetails.
+        :rtype: list[str]
+        """
+        return self._page_range
+
+    @page_range.setter
+    def page_range(self, page_range):
+        """
+        Sets the page_range of this InlineDocumentDetails.
+        The page ranges to be analysed.
+
+
+        :param page_range: The page_range of this InlineDocumentDetails.
+        :type: list[str]
+        """
+        self._page_range = page_range
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/ai_document/models/invoice_kv_model_sub_type_details.py

@@ -0,0 +1,110 @@
+# 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 InvoiceKvModelSubTypeDetails(object):
+    """
+    Invoice KV model sub type details
+    """
+
+    #: A constant which can be used with the model_sub_type property of a InvoiceKvModelSubTypeDetails.
+    #: This constant has a value of "RECEIPT"
+    MODEL_SUB_TYPE_RECEIPT = "RECEIPT"
+
+    #: A constant which can be used with the model_sub_type property of a InvoiceKvModelSubTypeDetails.
+    #: This constant has a value of "INVOICE"
+    MODEL_SUB_TYPE_INVOICE = "INVOICE"
+
+    #: A constant which can be used with the model_sub_type property of a InvoiceKvModelSubTypeDetails.
+    #: This constant has a value of "PASSPORT"
+    MODEL_SUB_TYPE_PASSPORT = "PASSPORT"
+
+    #: A constant which can be used with the model_sub_type property of a InvoiceKvModelSubTypeDetails.
+    #: This constant has a value of "DRIVER_LICENSE"
+    MODEL_SUB_TYPE_DRIVER_LICENSE = "DRIVER_LICENSE"
+
+    #: A constant which can be used with the model_sub_type property of a InvoiceKvModelSubTypeDetails.
+    #: This constant has a value of "HEALTH_INSURANCE_ID"
+    MODEL_SUB_TYPE_HEALTH_INSURANCE_ID = "HEALTH_INSURANCE_ID"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new InvoiceKvModelSubTypeDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_sub_type:
+            The value to assign to the model_sub_type property of this InvoiceKvModelSubTypeDetails.
+            Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"
+        :type model_sub_type: str
+
+        """
+        self.swagger_types = {
+            'model_sub_type': 'str'
+        }
+        self.attribute_map = {
+            'model_sub_type': 'modelSubType'
+        }
+        self._model_sub_type = None
+
+    @property
+    def model_sub_type(self):
+        """
+        **[Required]** Gets the model_sub_type of this InvoiceKvModelSubTypeDetails.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+        Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"
+
+
+        :return: The model_sub_type of this InvoiceKvModelSubTypeDetails.
+        :rtype: str
+        """
+        return self._model_sub_type
+
+    @model_sub_type.setter
+    def model_sub_type(self, model_sub_type):
+        """
+        Sets the model_sub_type of this InvoiceKvModelSubTypeDetails.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+
+        :param model_sub_type: The model_sub_type of this InvoiceKvModelSubTypeDetails.
+        :type: str
+        """
+        allowed_values = ["RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"]
+        if not value_allowed_none_or_none_sentinel(model_sub_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `model_sub_type`, must be None or one of {allowed_values}"
+            )
+        self._model_sub_type = model_sub_type
+
+    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/invoice_processor_config.py

@@ -0,0 +1,107 @@
+# 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 .processor_config import ProcessorConfig
+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 InvoiceProcessorConfig(ProcessorConfig):
+    """
+    The configuration of an invoice processor.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new InvoiceProcessorConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_document.models.InvoiceProcessorConfig.processor_type` attribute
+        of this class is ``INVOICE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param processor_type:
+            The value to assign to the processor_type property of this InvoiceProcessorConfig.
+            Allowed values for this property are: "GENERAL", "INVOICE"
+        :type processor_type: str
+
+        :param model_id:
+            The value to assign to the model_id property of this InvoiceProcessorConfig.
+        :type model_id: str
+
+        :param normalization_fields:
+            The value to assign to the normalization_fields property of this InvoiceProcessorConfig.
+        :type normalization_fields: oci.ai_document.models.NormalizationFields
+
+        """
+        self.swagger_types = {
+            'processor_type': 'str',
+            'model_id': 'str',
+            'normalization_fields': 'NormalizationFields'
+        }
+        self.attribute_map = {
+            'processor_type': 'processorType',
+            'model_id': 'modelId',
+            'normalization_fields': 'normalizationFields'
+        }
+        self._processor_type = None
+        self._model_id = None
+        self._normalization_fields = None
+        self._processor_type = 'INVOICE'
+
+    @property
+    def model_id(self):
+        """
+        Gets the model_id of this InvoiceProcessorConfig.
+        Unique identifier custom model OCID that should be used for inference.
+
+
+        :return: The model_id of this InvoiceProcessorConfig.
+        :rtype: str
+        """
+        return self._model_id
+
+    @model_id.setter
+    def model_id(self, model_id):
+        """
+        Sets the model_id of this InvoiceProcessorConfig.
+        Unique identifier custom model OCID that should be used for inference.
+
+
+        :param model_id: The model_id of this InvoiceProcessorConfig.
+        :type: str
+        """
+        self._model_id = model_id
+
+    @property
+    def normalization_fields(self):
+        """
+        **[Required]** Gets the normalization_fields of this InvoiceProcessorConfig.
+
+        :return: The normalization_fields of this InvoiceProcessorConfig.
+        :rtype: oci.ai_document.models.NormalizationFields
+        """
+        return self._normalization_fields
+
+    @normalization_fields.setter
+    def normalization_fields(self, normalization_fields):
+        """
+        Sets the normalization_fields of this InvoiceProcessorConfig.
+
+        :param normalization_fields: The normalization_fields of this InvoiceProcessorConfig.
+        :type: oci.ai_document.models.NormalizationFields
+        """
+        self._normalization_fields = normalization_fields
+
+    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/key_value_detection_model_metrics.py

@@ -23,7 +23,7 @@ class KeyValueDetectionModelMetrics(ModelMetrics):
 
         :param model_type:
             The value to assign to the model_type property of this KeyValueDetectionModelMetrics.
-            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/kv_model_sub_type.py

@@ -0,0 +1,121 @@
+# 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 .model_sub_type import ModelSubType
+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 KvModelSubType(ModelSubType):
+    """
+    The Kv model sub type
+    """
+
+    #: A constant which can be used with the model_sub_type property of a KvModelSubType.
+    #: This constant has a value of "RECEIPT"
+    MODEL_SUB_TYPE_RECEIPT = "RECEIPT"
+
+    #: A constant which can be used with the model_sub_type property of a KvModelSubType.
+    #: This constant has a value of "INVOICE"
+    MODEL_SUB_TYPE_INVOICE = "INVOICE"
+
+    #: A constant which can be used with the model_sub_type property of a KvModelSubType.
+    #: This constant has a value of "PASSPORT"
+    MODEL_SUB_TYPE_PASSPORT = "PASSPORT"
+
+    #: A constant which can be used with the model_sub_type property of a KvModelSubType.
+    #: This constant has a value of "DRIVER_LICENSE"
+    MODEL_SUB_TYPE_DRIVER_LICENSE = "DRIVER_LICENSE"
+
+    #: A constant which can be used with the model_sub_type property of a KvModelSubType.
+    #: This constant has a value of "HEALTH_INSURANCE_ID"
+    MODEL_SUB_TYPE_HEALTH_INSURANCE_ID = "HEALTH_INSURANCE_ID"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new KvModelSubType object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_document.models.KvModelSubType.model_type` attribute
+        of this class is ``PRE_TRAINED_KEY_VALUE_EXTRACTION`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_type:
+            The value to assign to the model_type property of this KvModelSubType.
+            Allowed values for this property are: "PRE_TRAINED_KEY_VALUE_EXTRACTION", "PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type model_type: str
+
+        :param model_sub_type:
+            The value to assign to the model_sub_type property of this KvModelSubType.
+            Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type model_sub_type: str
+
+        """
+        self.swagger_types = {
+            'model_type': 'str',
+            'model_sub_type': 'str'
+        }
+        self.attribute_map = {
+            'model_type': 'modelType',
+            'model_sub_type': 'modelSubType'
+        }
+        self._model_type = None
+        self._model_sub_type = None
+        self._model_type = 'PRE_TRAINED_KEY_VALUE_EXTRACTION'
+
+    @property
+    def model_sub_type(self):
+        """
+        **[Required]** Gets the model_sub_type of this KvModelSubType.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+        Allowed values for this property are: "RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The model_sub_type of this KvModelSubType.
+        :rtype: str
+        """
+        return self._model_sub_type
+
+    @model_sub_type.setter
+    def model_sub_type(self, model_sub_type):
+        """
+        Sets the model_sub_type of this KvModelSubType.
+        The model sub type for KEY_VALUE_EXTRACTION
+        The allowed values are:
+        - `RECEIPT`
+        - `INVOICE`
+        - `PASSPORT`
+        - `DRIVER_LICENSE`
+        - `HEALTH_INSURANCE_ID`
+
+
+        :param model_sub_type: The model_sub_type of this KvModelSubType.
+        :type: str
+        """
+        allowed_values = ["RECEIPT", "INVOICE", "PASSPORT", "DRIVER_LICENSE", "HEALTH_INSURANCE_ID"]
+        if not value_allowed_none_or_none_sentinel(model_sub_type, allowed_values):
+            model_sub_type = 'UNKNOWN_ENUM_VALUE'
+        self._model_sub_type = model_sub_type
+
+    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