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

oci/ai_language/models/health_entity.py

@@ -0,0 +1,351 @@
+# 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 HealthEntity(object):
+    """
+    Health entity object
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new HealthEntity object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param offset:
+            The value to assign to the offset property of this HealthEntity.
+        :type offset: int
+
+        :param length:
+            The value to assign to the length property of this HealthEntity.
+        :type length: int
+
+        :param text:
+            The value to assign to the text property of this HealthEntity.
+        :type text: str
+
+        :param type:
+            The value to assign to the type property of this HealthEntity.
+        :type type: str
+
+        :param sub_type:
+            The value to assign to the sub_type property of this HealthEntity.
+        :type sub_type: str
+
+        :param score:
+            The value to assign to the score property of this HealthEntity.
+        :type score: float
+
+        :param category:
+            The value to assign to the category property of this HealthEntity.
+        :type category: str
+
+        :param id:
+            The value to assign to the id property of this HealthEntity.
+        :type id: str
+
+        :param assertions:
+            The value to assign to the assertions property of this HealthEntity.
+        :type assertions: list[oci.ai_language.models.AssertionDetails]
+
+        :param matched_concepts:
+            The value to assign to the matched_concepts property of this HealthEntity.
+        :type matched_concepts: list[oci.ai_language.models.MelConcept]
+
+        """
+        self.swagger_types = {
+            'offset': 'int',
+            'length': 'int',
+            'text': 'str',
+            'type': 'str',
+            'sub_type': 'str',
+            'score': 'float',
+            'category': 'str',
+            'id': 'str',
+            'assertions': 'list[AssertionDetails]',
+            'matched_concepts': 'list[MelConcept]'
+        }
+
+        self.attribute_map = {
+            'offset': 'offset',
+            'length': 'length',
+            'text': 'text',
+            'type': 'type',
+            'sub_type': 'subType',
+            'score': 'score',
+            'category': 'category',
+            'id': 'id',
+            'assertions': 'assertions',
+            'matched_concepts': 'matchedConcepts'
+        }
+
+        self._offset = None
+        self._length = None
+        self._text = None
+        self._type = None
+        self._sub_type = None
+        self._score = None
+        self._category = None
+        self._id = None
+        self._assertions = None
+        self._matched_concepts = None
+
+    @property
+    def offset(self):
+        """
+        **[Required]** Gets the offset of this HealthEntity.
+        The number of Unicode code points preceding this entity in the submitted text.
+
+
+        :return: The offset of this HealthEntity.
+        :rtype: int
+        """
+        return self._offset
+
+    @offset.setter
+    def offset(self, offset):
+        """
+        Sets the offset of this HealthEntity.
+        The number of Unicode code points preceding this entity in the submitted text.
+
+
+        :param offset: The offset of this HealthEntity.
+        :type: int
+        """
+        self._offset = offset
+
+    @property
+    def length(self):
+        """
+        **[Required]** Gets the length of this HealthEntity.
+        Length of entity text
+
+
+        :return: The length of this HealthEntity.
+        :rtype: int
+        """
+        return self._length
+
+    @length.setter
+    def length(self, length):
+        """
+        Sets the length of this HealthEntity.
+        Length of entity text
+
+
+        :param length: The length of this HealthEntity.
+        :type: int
+        """
+        self._length = length
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this HealthEntity.
+        Entity text like name of person, location, and so on.
+
+
+        :return: The text of this HealthEntity.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this HealthEntity.
+        Entity text like name of person, location, and so on.
+
+
+        :param text: The text of this HealthEntity.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this HealthEntity.
+        Type of entity text like PER, LOC.
+
+
+        :return: The type of this HealthEntity.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this HealthEntity.
+        Type of entity text like PER, LOC.
+
+
+        :param type: The type of this HealthEntity.
+        :type: str
+        """
+        self._type = type
+
+    @property
+    def sub_type(self):
+        """
+        Gets the sub_type of this HealthEntity.
+        Sub-type of entity text like GPE for LOCATION type
+
+
+        :return: The sub_type of this HealthEntity.
+        :rtype: str
+        """
+        return self._sub_type
+
+    @sub_type.setter
+    def sub_type(self, sub_type):
+        """
+        Sets the sub_type of this HealthEntity.
+        Sub-type of entity text like GPE for LOCATION type
+
+
+        :param sub_type: The sub_type of this HealthEntity.
+        :type: str
+        """
+        self._sub_type = sub_type
+
+    @property
+    def score(self):
+        """
+        **[Required]** Gets the score of this HealthEntity.
+        Score or confidence for detected entity.
+
+
+        :return: The score of this HealthEntity.
+        :rtype: float
+        """
+        return self._score
+
+    @score.setter
+    def score(self, score):
+        """
+        Sets the score of this HealthEntity.
+        Score or confidence for detected entity.
+
+
+        :param score: The score of this HealthEntity.
+        :type: float
+        """
+        self._score = score
+
+    @property
+    def category(self):
+        """
+        Gets the category of this HealthEntity.
+        Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY
+
+
+        :return: The category of this HealthEntity.
+        :rtype: str
+        """
+        return self._category
+
+    @category.setter
+    def category(self, category):
+        """
+        Sets the category of this HealthEntity.
+        Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY
+
+
+        :param category: The category of this HealthEntity.
+        :type: str
+        """
+        self._category = category
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this HealthEntity.
+        Unique id of the entity
+
+
+        :return: The id of this HealthEntity.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this HealthEntity.
+        Unique id of the entity
+
+
+        :param id: The id of this HealthEntity.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def assertions(self):
+        """
+        Gets the assertions of this HealthEntity.
+        list of all assertions associated with this entity.
+
+
+        :return: The assertions of this HealthEntity.
+        :rtype: list[oci.ai_language.models.AssertionDetails]
+        """
+        return self._assertions
+
+    @assertions.setter
+    def assertions(self, assertions):
+        """
+        Sets the assertions of this HealthEntity.
+        list of all assertions associated with this entity.
+
+
+        :param assertions: The assertions of this HealthEntity.
+        :type: list[oci.ai_language.models.AssertionDetails]
+        """
+        self._assertions = assertions
+
+    @property
+    def matched_concepts(self):
+        """
+        Gets the matched_concepts of this HealthEntity.
+        This contains the list of matched concepts which are ranked by the relevant score with the input text
+
+
+        :return: The matched_concepts of this HealthEntity.
+        :rtype: list[oci.ai_language.models.MelConcept]
+        """
+        return self._matched_concepts
+
+    @matched_concepts.setter
+    def matched_concepts(self, matched_concepts):
+        """
+        Sets the matched_concepts of this HealthEntity.
+        This contains the list of matched concepts which are ranked by the relevant score with the input text
+
+
+        :param matched_concepts: The matched_concepts of this HealthEntity.
+        :type: list[oci.ai_language.models.MelConcept]
+        """
+        self._matched_concepts = matched_concepts
+
+    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/health_entity_document_result.py

@@ -0,0 +1,200 @@
+# 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 HealthEntityDocumentResult(object):
+    """
+    The document response for health entity detect call.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new HealthEntityDocumentResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param key:
+            The value to assign to the key property of this HealthEntityDocumentResult.
+        :type key: str
+
+        :param entities:
+            The value to assign to the entities property of this HealthEntityDocumentResult.
+        :type entities: list[oci.ai_language.models.HealthEntity]
+
+        :param relations:
+            The value to assign to the relations property of this HealthEntityDocumentResult.
+        :type relations: list[oci.ai_language.models.RelationEntity]
+
+        :param resolved_entities:
+            The value to assign to the resolved_entities property of this HealthEntityDocumentResult.
+        :type resolved_entities: dict(str, ResolvedEntities)
+
+        :param language_code:
+            The value to assign to the language_code property of this HealthEntityDocumentResult.
+        :type language_code: str
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'entities': 'list[HealthEntity]',
+            'relations': 'list[RelationEntity]',
+            'resolved_entities': 'dict(str, ResolvedEntities)',
+            'language_code': 'str'
+        }
+
+        self.attribute_map = {
+            'key': 'key',
+            'entities': 'entities',
+            'relations': 'relations',
+            'resolved_entities': 'resolvedEntities',
+            'language_code': 'languageCode'
+        }
+
+        self._key = None
+        self._entities = None
+        self._relations = None
+        self._resolved_entities = None
+        self._language_code = None
+
+    @property
+    def key(self):
+        """
+        **[Required]** Gets the key of this HealthEntityDocumentResult.
+        Document unique identifier defined by the user.
+
+
+        :return: The key of this HealthEntityDocumentResult.
+        :rtype: str
+        """
+        return self._key
+
+    @key.setter
+    def key(self, key):
+        """
+        Sets the key of this HealthEntityDocumentResult.
+        Document unique identifier defined by the user.
+
+
+        :param key: The key of this HealthEntityDocumentResult.
+        :type: str
+        """
+        self._key = key
+
+    @property
+    def entities(self):
+        """
+        **[Required]** Gets the entities of this HealthEntityDocumentResult.
+        List of detected entities.
+
+
+        :return: The entities of this HealthEntityDocumentResult.
+        :rtype: list[oci.ai_language.models.HealthEntity]
+        """
+        return self._entities
+
+    @entities.setter
+    def entities(self, entities):
+        """
+        Sets the entities of this HealthEntityDocumentResult.
+        List of detected entities.
+
+
+        :param entities: The entities of this HealthEntityDocumentResult.
+        :type: list[oci.ai_language.models.HealthEntity]
+        """
+        self._entities = entities
+
+    @property
+    def relations(self):
+        """
+        Gets the relations of this HealthEntityDocumentResult.
+        List of succeeded document response.
+
+
+        :return: The relations of this HealthEntityDocumentResult.
+        :rtype: list[oci.ai_language.models.RelationEntity]
+        """
+        return self._relations
+
+    @relations.setter
+    def relations(self, relations):
+        """
+        Sets the relations of this HealthEntityDocumentResult.
+        List of succeeded document response.
+
+
+        :param relations: The relations of this HealthEntityDocumentResult.
+        :type: list[oci.ai_language.models.RelationEntity]
+        """
+        self._relations = relations
+
+    @property
+    def resolved_entities(self):
+        """
+        **[Required]** Gets the resolved_entities of this HealthEntityDocumentResult.
+        Map of resolved entities by entity type
+
+
+        :return: The resolved_entities of this HealthEntityDocumentResult.
+        :rtype: dict(str, ResolvedEntities)
+        """
+        return self._resolved_entities
+
+    @resolved_entities.setter
+    def resolved_entities(self, resolved_entities):
+        """
+        Sets the resolved_entities of this HealthEntityDocumentResult.
+        Map of resolved entities by entity type
+
+
+        :param resolved_entities: The resolved_entities of this HealthEntityDocumentResult.
+        :type: dict(str, ResolvedEntities)
+        """
+        self._resolved_entities = resolved_entities
+
+    @property
+    def language_code(self):
+        """
+        **[Required]** Gets the language_code of this HealthEntityDocumentResult.
+        Language code of the document. Please refer to respective model `API documentation`__ for supported languages.
+
+        __ https://docs.cloud.oracle.com/iaas/language/using/overview.htm
+
+
+        :return: The language_code of this HealthEntityDocumentResult.
+        :rtype: str
+        """
+        return self._language_code
+
+    @language_code.setter
+    def language_code(self, language_code):
+        """
+        Sets the language_code of this HealthEntityDocumentResult.
+        Language code of the document. Please refer to respective model `API documentation`__ for supported languages.
+
+        __ https://docs.cloud.oracle.com/iaas/language/using/overview.htm
+
+
+        :param language_code: The language_code of this HealthEntityDocumentResult.
+        :type: str
+        """
+        self._language_code = language_code
+
+    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/input_location.py

@@ -13,8 +13,9 @@ from oci.decorators import init_model_state_from_kwargs
 class InputLocation(object):
     """
     document location and other meta data about documents
-    For TXT both ObjectStoragePrefixLocation and ObjectStorageFileNameLocation supported
+    For TXT only ObjectStoragePrefixLocation supported
     For CSV only ObjectStorageFileNameLocation is supported
+    For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
     """
 
     #: A constant which can be used with the location_type property of a InputLocation.

oci/ai_language/models/mel_concept.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 MelConcept(object):
+    """
+    The MEL concepts details for health ner.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new MelConcept object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param ontology_name:
+            The value to assign to the ontology_name property of this MelConcept.
+        :type ontology_name: str
+
+        :param concepts:
+            The value to assign to the concepts property of this MelConcept.
+        :type concepts: list[oci.ai_language.models.MelConceptDetails]
+
+        """
+        self.swagger_types = {
+            'ontology_name': 'str',
+            'concepts': 'list[MelConceptDetails]'
+        }
+
+        self.attribute_map = {
+            'ontology_name': 'ontologyName',
+            'concepts': 'concepts'
+        }
+
+        self._ontology_name = None
+        self._concepts = None
+
+    @property
+    def ontology_name(self):
+        """
+        **[Required]** Gets the ontology_name of this MelConcept.
+        Name of the ontology to which the Entity is mapped
+
+
+        :return: The ontology_name of this MelConcept.
+        :rtype: str
+        """
+        return self._ontology_name
+
+    @ontology_name.setter
+    def ontology_name(self, ontology_name):
+        """
+        Sets the ontology_name of this MelConcept.
+        Name of the ontology to which the Entity is mapped
+
+
+        :param ontology_name: The ontology_name of this MelConcept.
+        :type: str
+        """
+        self._ontology_name = ontology_name
+
+    @property
+    def concepts(self):
+        """
+        **[Required]** Gets the concepts of this MelConcept.
+        This contains the list of matched concepts which are ranked by the relevant score with the input text
+
+
+        :return: The concepts of this MelConcept.
+        :rtype: list[oci.ai_language.models.MelConceptDetails]
+        """
+        return self._concepts
+
+    @concepts.setter
+    def concepts(self, concepts):
+        """
+        Sets the concepts of this MelConcept.
+        This contains the list of matched concepts which are ranked by the relevant score with the input text
+
+
+        :param concepts: The concepts of this MelConcept.
+        :type: list[oci.ai_language.models.MelConceptDetails]
+        """
+        self._concepts = concepts
+
+    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