oci 2.125.2__py3-none-any.whl → 2.126.0__py3-none-any.whl

oci/ai_language/models/assertion_details.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20221001
+
+
+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 AssertionDetails(object):
+    """
+    The assertion details for health ner.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new AssertionDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this AssertionDetails.
+        :type id: str
+
+        :param type:
+            The value to assign to the type property of this AssertionDetails.
+        :type type: str
+
+        :param value:
+            The value to assign to the value property of this AssertionDetails.
+        :type value: str
+
+        :param score:
+            The value to assign to the score property of this AssertionDetails.
+        :type score: float
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'type': 'str',
+            'value': 'str',
+            'score': 'float'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'type': 'type',
+            'value': 'value',
+            'score': 'score'
+        }
+
+        self._id = None
+        self._type = None
+        self._value = None
+        self._score = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this AssertionDetails.
+        id of the relation
+
+
+        :return: The id of this AssertionDetails.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this AssertionDetails.
+        id of the relation
+
+
+        :param id: The id of this AssertionDetails.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this AssertionDetails.
+        type of assertion ex, Status, Certainty, Temporality, Actor, etc.
+
+
+        :return: The type of this AssertionDetails.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this AssertionDetails.
+        type of assertion ex, Status, Certainty, Temporality, Actor, etc.
+
+
+        :param type: The type of this AssertionDetails.
+        :type: str
+        """
+        self._type = type
+
+    @property
+    def value(self):
+        """
+        **[Required]** Gets the value of this AssertionDetails.
+        Possible value for assertion type
+
+
+        :return: The value of this AssertionDetails.
+        :rtype: str
+        """
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        """
+        Sets the value of this AssertionDetails.
+        Possible value for assertion type
+
+
+        :param value: The value of this AssertionDetails.
+        :type: str
+        """
+        self._value = value
+
+    @property
+    def score(self):
+        """
+        **[Required]** Gets the score of this AssertionDetails.
+        Score or confidence for health detected entity.
+
+
+        :return: The score of this AssertionDetails.
+        :rtype: float
+        """
+        return self._score
+
+    @score.setter
+    def score(self, score):
+        """
+        Sets the score of this AssertionDetails.
+        Score or confidence for health detected entity.
+
+
+        :param score: The score of this AssertionDetails.
+        :type: float
+        """
+        self._score = score
+
+    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_language/models/batch_detect_health_entity_details.py

@@ -0,0 +1,223 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20221001
+
+
+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 BatchDetectHealthEntityDetails(object):
+    """
+    The documents details for health entities detect call.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BatchDetectHealthEntityDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param endpoint_id:
+            The value to assign to the endpoint_id property of this BatchDetectHealthEntityDetails.
+        :type endpoint_id: str
+
+        :param documents:
+            The value to assign to the documents property of this BatchDetectHealthEntityDetails.
+        :type documents: list[oci.ai_language.models.TextDocument]
+
+        :param link_ontologies:
+            The value to assign to the link_ontologies property of this BatchDetectHealthEntityDetails.
+        :type link_ontologies: list[str]
+
+        :param is_detect_assertions:
+            The value to assign to the is_detect_assertions property of this BatchDetectHealthEntityDetails.
+        :type is_detect_assertions: bool
+
+        :param is_detect_relationships:
+            The value to assign to the is_detect_relationships property of this BatchDetectHealthEntityDetails.
+        :type is_detect_relationships: bool
+
+        :param profile:
+            The value to assign to the profile property of this BatchDetectHealthEntityDetails.
+        :type profile: oci.ai_language.models.Profile
+
+        """
+        self.swagger_types = {
+            'endpoint_id': 'str',
+            'documents': 'list[TextDocument]',
+            'link_ontologies': 'list[str]',
+            'is_detect_assertions': 'bool',
+            'is_detect_relationships': 'bool',
+            'profile': 'Profile'
+        }
+
+        self.attribute_map = {
+            'endpoint_id': 'endpointId',
+            'documents': 'documents',
+            'link_ontologies': 'linkOntologies',
+            'is_detect_assertions': 'isDetectAssertions',
+            'is_detect_relationships': 'isDetectRelationships',
+            'profile': 'profile'
+        }
+
+        self._endpoint_id = None
+        self._documents = None
+        self._link_ontologies = None
+        self._is_detect_assertions = None
+        self._is_detect_relationships = None
+        self._profile = None
+
+    @property
+    def endpoint_id(self):
+        """
+        **[Required]** Gets the endpoint_id of this BatchDetectHealthEntityDetails.
+        The endpoint which have to be used for inferencing.
+
+
+        :return: The endpoint_id of this BatchDetectHealthEntityDetails.
+        :rtype: str
+        """
+        return self._endpoint_id
+
+    @endpoint_id.setter
+    def endpoint_id(self, endpoint_id):
+        """
+        Sets the endpoint_id of this BatchDetectHealthEntityDetails.
+        The endpoint which have to be used for inferencing.
+
+
+        :param endpoint_id: The endpoint_id of this BatchDetectHealthEntityDetails.
+        :type: str
+        """
+        self._endpoint_id = endpoint_id
+
+    @property
+    def documents(self):
+        """
+        **[Required]** Gets the documents of this BatchDetectHealthEntityDetails.
+        List of Documents for detect health entities.
+
+
+        :return: The documents of this BatchDetectHealthEntityDetails.
+        :rtype: list[oci.ai_language.models.TextDocument]
+        """
+        return self._documents
+
+    @documents.setter
+    def documents(self, documents):
+        """
+        Sets the documents of this BatchDetectHealthEntityDetails.
+        List of Documents for detect health entities.
+
+
+        :param documents: The documents of this BatchDetectHealthEntityDetails.
+        :type: list[oci.ai_language.models.TextDocument]
+        """
+        self._documents = documents
+
+    @property
+    def link_ontologies(self):
+        """
+        Gets the link_ontologies of this BatchDetectHealthEntityDetails.
+        List of NLP health ontologies to be linked
+
+
+        :return: The link_ontologies of this BatchDetectHealthEntityDetails.
+        :rtype: list[str]
+        """
+        return self._link_ontologies
+
+    @link_ontologies.setter
+    def link_ontologies(self, link_ontologies):
+        """
+        Sets the link_ontologies of this BatchDetectHealthEntityDetails.
+        List of NLP health ontologies to be linked
+
+
+        :param link_ontologies: The link_ontologies of this BatchDetectHealthEntityDetails.
+        :type: list[str]
+        """
+        self._link_ontologies = link_ontologies
+
+    @property
+    def is_detect_assertions(self):
+        """
+        Gets the is_detect_assertions of this BatchDetectHealthEntityDetails.
+        is assertion on input text required. default value true.
+
+
+        :return: The is_detect_assertions of this BatchDetectHealthEntityDetails.
+        :rtype: bool
+        """
+        return self._is_detect_assertions
+
+    @is_detect_assertions.setter
+    def is_detect_assertions(self, is_detect_assertions):
+        """
+        Sets the is_detect_assertions of this BatchDetectHealthEntityDetails.
+        is assertion on input text required. default value true.
+
+
+        :param is_detect_assertions: The is_detect_assertions of this BatchDetectHealthEntityDetails.
+        :type: bool
+        """
+        self._is_detect_assertions = is_detect_assertions
+
+    @property
+    def is_detect_relationships(self):
+        """
+        Gets the is_detect_relationships of this BatchDetectHealthEntityDetails.
+        is relationship on input text required. default value true.
+
+
+        :return: The is_detect_relationships of this BatchDetectHealthEntityDetails.
+        :rtype: bool
+        """
+        return self._is_detect_relationships
+
+    @is_detect_relationships.setter
+    def is_detect_relationships(self, is_detect_relationships):
+        """
+        Sets the is_detect_relationships of this BatchDetectHealthEntityDetails.
+        is relationship on input text required. default value true.
+
+
+        :param is_detect_relationships: The is_detect_relationships of this BatchDetectHealthEntityDetails.
+        :type: bool
+        """
+        self._is_detect_relationships = is_detect_relationships
+
+    @property
+    def profile(self):
+        """
+        Gets the profile of this BatchDetectHealthEntityDetails.
+
+        :return: The profile of this BatchDetectHealthEntityDetails.
+        :rtype: oci.ai_language.models.Profile
+        """
+        return self._profile
+
+    @profile.setter
+    def profile(self, profile):
+        """
+        Sets the profile of this BatchDetectHealthEntityDetails.
+
+        :param profile: The profile of this BatchDetectHealthEntityDetails.
+        :type: oci.ai_language.models.Profile
+        """
+        self._profile = profile
+
+    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_language/models/batch_detect_health_entity_result.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20221001
+
+
+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 BatchDetectHealthEntityResult(object):
+    """
+    Result of health entity detect call.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BatchDetectHealthEntityResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param documents:
+            The value to assign to the documents property of this BatchDetectHealthEntityResult.
+        :type documents: list[oci.ai_language.models.HealthEntityDocumentResult]
+
+        :param errors:
+            The value to assign to the errors property of this BatchDetectHealthEntityResult.
+        :type errors: list[oci.ai_language.models.DocumentError]
+
+        """
+        self.swagger_types = {
+            'documents': 'list[HealthEntityDocumentResult]',
+            'errors': 'list[DocumentError]'
+        }
+
+        self.attribute_map = {
+            'documents': 'documents',
+            'errors': 'errors'
+        }
+
+        self._documents = None
+        self._errors = None
+
+    @property
+    def documents(self):
+        """
+        **[Required]** Gets the documents of this BatchDetectHealthEntityResult.
+        List of succeeded document response.
+
+
+        :return: The documents of this BatchDetectHealthEntityResult.
+        :rtype: list[oci.ai_language.models.HealthEntityDocumentResult]
+        """
+        return self._documents
+
+    @documents.setter
+    def documents(self, documents):
+        """
+        Sets the documents of this BatchDetectHealthEntityResult.
+        List of succeeded document response.
+
+
+        :param documents: The documents of this BatchDetectHealthEntityResult.
+        :type: list[oci.ai_language.models.HealthEntityDocumentResult]
+        """
+        self._documents = documents
+
+    @property
+    def errors(self):
+        """
+        Gets the errors of this BatchDetectHealthEntityResult.
+        List of failed document response.
+
+
+        :return: The errors of this BatchDetectHealthEntityResult.
+        :rtype: list[oci.ai_language.models.DocumentError]
+        """
+        return self._errors
+
+    @errors.setter
+    def errors(self, errors):
+        """
+        Sets the errors of this BatchDetectHealthEntityResult.
+        List of failed document response.
+
+
+        :param errors: The errors of this BatchDetectHealthEntityResult.
+        :type: list[oci.ai_language.models.DocumentError]
+        """
+        self._errors = errors
+
+    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_language/models/batch_detect_language_pii_entities_details.py

@@ -36,25 +36,32 @@ class BatchDetectLanguagePiiEntitiesDetails(object):
             The value to assign to the masking property of this BatchDetectLanguagePiiEntitiesDetails.
         :type masking: dict(str, PiiEntityMasking)
 
+        :param profile:
+            The value to assign to the profile property of this BatchDetectLanguagePiiEntitiesDetails.
+        :type profile: oci.ai_language.models.Profile
+
         """
         self.swagger_types = {
             'endpoint_id': 'str',
             'compartment_id': 'str',
             'documents': 'list[TextDocument]',
-            'masking': 'dict(str, PiiEntityMasking)'
+            'masking': 'dict(str, PiiEntityMasking)',
+            'profile': 'Profile'
         }
 
         self.attribute_map = {
             'endpoint_id': 'endpointId',
             'compartment_id': 'compartmentId',
             'documents': 'documents',
-            'masking': 'masking'
+            'masking': 'masking',
+            'profile': 'profile'
         }
 
         self._endpoint_id = None
         self._compartment_id = None
         self._documents = None
         self._masking = None
+        self._profile = None
 
     @property
     def endpoint_id(self):
@@ -156,6 +163,26 @@ class BatchDetectLanguagePiiEntitiesDetails(object):
         """
         self._masking = masking
 
+    @property
+    def profile(self):
+        """
+        Gets the profile of this BatchDetectLanguagePiiEntitiesDetails.
+
+        :return: The profile of this BatchDetectLanguagePiiEntitiesDetails.
+        :rtype: oci.ai_language.models.Profile
+        """
+        return self._profile
+
+    @profile.setter
+    def profile(self, profile):
+        """
+        Sets the profile of this BatchDetectLanguagePiiEntitiesDetails.
+
+        :param profile: The profile of this BatchDetectLanguagePiiEntitiesDetails.
+        :type: oci.ai_language.models.Profile
+        """
+        self._profile = profile
+
     def __repr__(self):
         return formatted_flat_dict(self)