oci 2.139.0__py3-none-any.whl → 2.141.0__py3-none-any.whl

oci/ai_vision/models/video_face_frame.py

@@ -0,0 +1,192 @@
+# 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: 20220125
+
+
+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 VideoFaceFrame(object):
+    """
+    A face frame.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new VideoFaceFrame object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param time_offset_ms:
+            The value to assign to the time_offset_ms property of this VideoFaceFrame.
+        :type time_offset_ms: int
+
+        :param confidence:
+            The value to assign to the confidence property of this VideoFaceFrame.
+        :type confidence: float
+
+        :param quality_score:
+            The value to assign to the quality_score property of this VideoFaceFrame.
+        :type quality_score: float
+
+        :param bounding_polygon:
+            The value to assign to the bounding_polygon property of this VideoFaceFrame.
+        :type bounding_polygon: oci.ai_vision.models.BoundingPolygon
+
+        :param landmarks:
+            The value to assign to the landmarks property of this VideoFaceFrame.
+        :type landmarks: list[oci.ai_vision.models.Landmark]
+
+        """
+        self.swagger_types = {
+            'time_offset_ms': 'int',
+            'confidence': 'float',
+            'quality_score': 'float',
+            'bounding_polygon': 'BoundingPolygon',
+            'landmarks': 'list[Landmark]'
+        }
+
+        self.attribute_map = {
+            'time_offset_ms': 'timeOffsetMs',
+            'confidence': 'confidence',
+            'quality_score': 'qualityScore',
+            'bounding_polygon': 'boundingPolygon',
+            'landmarks': 'landmarks'
+        }
+
+        self._time_offset_ms = None
+        self._confidence = None
+        self._quality_score = None
+        self._bounding_polygon = None
+        self._landmarks = None
+
+    @property
+    def time_offset_ms(self):
+        """
+        **[Required]** Gets the time_offset_ms of this VideoFaceFrame.
+        Time offset(Milliseconds) in the video.
+
+
+        :return: The time_offset_ms of this VideoFaceFrame.
+        :rtype: int
+        """
+        return self._time_offset_ms
+
+    @time_offset_ms.setter
+    def time_offset_ms(self, time_offset_ms):
+        """
+        Sets the time_offset_ms of this VideoFaceFrame.
+        Time offset(Milliseconds) in the video.
+
+
+        :param time_offset_ms: The time_offset_ms of this VideoFaceFrame.
+        :type: int
+        """
+        self._time_offset_ms = time_offset_ms
+
+    @property
+    def confidence(self):
+        """
+        **[Required]** Gets the confidence of this VideoFaceFrame.
+        The confidence score, between 0 and 1.
+
+
+        :return: The confidence of this VideoFaceFrame.
+        :rtype: float
+        """
+        return self._confidence
+
+    @confidence.setter
+    def confidence(self, confidence):
+        """
+        Sets the confidence of this VideoFaceFrame.
+        The confidence score, between 0 and 1.
+
+
+        :param confidence: The confidence of this VideoFaceFrame.
+        :type: float
+        """
+        self._confidence = confidence
+
+    @property
+    def quality_score(self):
+        """
+        **[Required]** Gets the quality_score of this VideoFaceFrame.
+        The quality score of the face detected, between 0 and 1.
+
+
+        :return: The quality_score of this VideoFaceFrame.
+        :rtype: float
+        """
+        return self._quality_score
+
+    @quality_score.setter
+    def quality_score(self, quality_score):
+        """
+        Sets the quality_score of this VideoFaceFrame.
+        The quality score of the face detected, between 0 and 1.
+
+
+        :param quality_score: The quality_score of this VideoFaceFrame.
+        :type: float
+        """
+        self._quality_score = quality_score
+
+    @property
+    def bounding_polygon(self):
+        """
+        **[Required]** Gets the bounding_polygon of this VideoFaceFrame.
+
+        :return: The bounding_polygon of this VideoFaceFrame.
+        :rtype: oci.ai_vision.models.BoundingPolygon
+        """
+        return self._bounding_polygon
+
+    @bounding_polygon.setter
+    def bounding_polygon(self, bounding_polygon):
+        """
+        Sets the bounding_polygon of this VideoFaceFrame.
+
+        :param bounding_polygon: The bounding_polygon of this VideoFaceFrame.
+        :type: oci.ai_vision.models.BoundingPolygon
+        """
+        self._bounding_polygon = bounding_polygon
+
+    @property
+    def landmarks(self):
+        """
+        Gets the landmarks of this VideoFaceFrame.
+        Face landmarks.
+
+
+        :return: The landmarks of this VideoFaceFrame.
+        :rtype: list[oci.ai_vision.models.Landmark]
+        """
+        return self._landmarks
+
+    @landmarks.setter
+    def landmarks(self, landmarks):
+        """
+        Sets the landmarks of this VideoFaceFrame.
+        Face landmarks.
+
+
+        :param landmarks: The landmarks of this VideoFaceFrame.
+        :type: list[oci.ai_vision.models.Landmark]
+        """
+        self._landmarks = landmarks
+
+    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_vision/models/video_face_segment.py

@@ -0,0 +1,130 @@
+# 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: 20220125
+
+
+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 VideoFaceSegment(object):
+    """
+    A face segment in a video.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new VideoFaceSegment object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param video_segment:
+            The value to assign to the video_segment property of this VideoFaceSegment.
+        :type video_segment: oci.ai_vision.models.VideoSegment
+
+        :param confidence:
+            The value to assign to the confidence property of this VideoFaceSegment.
+        :type confidence: float
+
+        :param frames:
+            The value to assign to the frames property of this VideoFaceSegment.
+        :type frames: list[oci.ai_vision.models.VideoFaceFrame]
+
+        """
+        self.swagger_types = {
+            'video_segment': 'VideoSegment',
+            'confidence': 'float',
+            'frames': 'list[VideoFaceFrame]'
+        }
+
+        self.attribute_map = {
+            'video_segment': 'videoSegment',
+            'confidence': 'confidence',
+            'frames': 'frames'
+        }
+
+        self._video_segment = None
+        self._confidence = None
+        self._frames = None
+
+    @property
+    def video_segment(self):
+        """
+        **[Required]** Gets the video_segment of this VideoFaceSegment.
+
+        :return: The video_segment of this VideoFaceSegment.
+        :rtype: oci.ai_vision.models.VideoSegment
+        """
+        return self._video_segment
+
+    @video_segment.setter
+    def video_segment(self, video_segment):
+        """
+        Sets the video_segment of this VideoFaceSegment.
+
+        :param video_segment: The video_segment of this VideoFaceSegment.
+        :type: oci.ai_vision.models.VideoSegment
+        """
+        self._video_segment = video_segment
+
+    @property
+    def confidence(self):
+        """
+        **[Required]** Gets the confidence of this VideoFaceSegment.
+        The confidence score, between 0 and 1.
+
+
+        :return: The confidence of this VideoFaceSegment.
+        :rtype: float
+        """
+        return self._confidence
+
+    @confidence.setter
+    def confidence(self, confidence):
+        """
+        Sets the confidence of this VideoFaceSegment.
+        The confidence score, between 0 and 1.
+
+
+        :param confidence: The confidence of this VideoFaceSegment.
+        :type: float
+        """
+        self._confidence = confidence
+
+    @property
+    def frames(self):
+        """
+        **[Required]** Gets the frames of this VideoFaceSegment.
+        Face frames in a segment.
+
+
+        :return: The frames of this VideoFaceSegment.
+        :rtype: list[oci.ai_vision.models.VideoFaceFrame]
+        """
+        return self._frames
+
+    @frames.setter
+    def frames(self, frames):
+        """
+        Sets the frames of this VideoFaceSegment.
+        Face frames in a segment.
+
+
+        :param frames: The frames of this VideoFaceSegment.
+        :type: list[oci.ai_vision.models.VideoFaceFrame]
+        """
+        self._frames = frames
+
+    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_vision/models/video_feature.py

@@ -0,0 +1,145 @@
+# 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: 20220125
+
+
+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 VideoFeature(object):
+    """
+    Details about a video feature request.
+    """
+
+    #: A constant which can be used with the feature_type property of a VideoFeature.
+    #: This constant has a value of "LABEL_DETECTION"
+    FEATURE_TYPE_LABEL_DETECTION = "LABEL_DETECTION"
+
+    #: A constant which can be used with the feature_type property of a VideoFeature.
+    #: This constant has a value of "OBJECT_DETECTION"
+    FEATURE_TYPE_OBJECT_DETECTION = "OBJECT_DETECTION"
+
+    #: A constant which can be used with the feature_type property of a VideoFeature.
+    #: This constant has a value of "TEXT_DETECTION"
+    FEATURE_TYPE_TEXT_DETECTION = "TEXT_DETECTION"
+
+    #: A constant which can be used with the feature_type property of a VideoFeature.
+    #: This constant has a value of "FACE_DETECTION"
+    FEATURE_TYPE_FACE_DETECTION = "FACE_DETECTION"
+
+    #: A constant which can be used with the feature_type property of a VideoFeature.
+    #: This constant has a value of "OBJECT_TRACKING"
+    FEATURE_TYPE_OBJECT_TRACKING = "OBJECT_TRACKING"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new VideoFeature object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.ai_vision.models.VideoObjectDetectionFeature`
+        * :class:`~oci.ai_vision.models.VideoFaceDetectionFeature`
+        * :class:`~oci.ai_vision.models.VideoTextDetectionFeature`
+        * :class:`~oci.ai_vision.models.VideoObjectTrackingFeature`
+        * :class:`~oci.ai_vision.models.VideoLabelDetectionFeature`
+
+        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 VideoFeature.
+            Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type feature_type: str
+
+        """
+        self.swagger_types = {
+            'feature_type': 'str'
+        }
+
+        self.attribute_map = {
+            'feature_type': 'featureType'
+        }
+
+        self._feature_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['featureType']
+
+        if type == 'OBJECT_DETECTION':
+            return 'VideoObjectDetectionFeature'
+
+        if type == 'FACE_DETECTION':
+            return 'VideoFaceDetectionFeature'
+
+        if type == 'TEXT_DETECTION':
+            return 'VideoTextDetectionFeature'
+
+        if type == 'OBJECT_TRACKING':
+            return 'VideoObjectTrackingFeature'
+
+        if type == 'LABEL_DETECTION':
+            return 'VideoLabelDetectionFeature'
+        else:
+            return 'VideoFeature'
+
+    @property
+    def feature_type(self):
+        """
+        **[Required]** Gets the feature_type of this VideoFeature.
+        The feature of video analysis.
+        Allowed values are:
+        - LABEL_DETECTION: Label detection feature(IC).
+        - OBJECT_DETECTION: Object detection feature(OD).
+        - TEXT_DETECTION: Text detection feature(OCR).
+        - FACE_DETECTION: Face detection feature(fd).
+        - OBJECT_TRACKING: Object tracking feature(OT).
+
+        Allowed values for this property are: "LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The feature_type of this VideoFeature.
+        :rtype: str
+        """
+        return self._feature_type
+
+    @feature_type.setter
+    def feature_type(self, feature_type):
+        """
+        Sets the feature_type of this VideoFeature.
+        The feature of video analysis.
+        Allowed values are:
+        - LABEL_DETECTION: Label detection feature(IC).
+        - OBJECT_DETECTION: Object detection feature(OD).
+        - TEXT_DETECTION: Text detection feature(OCR).
+        - FACE_DETECTION: Face detection feature(fd).
+        - OBJECT_TRACKING: Object tracking feature(OT).
+
+
+        :param feature_type: The feature_type of this VideoFeature.
+        :type: str
+        """
+        allowed_values = ["LABEL_DETECTION", "OBJECT_DETECTION", "TEXT_DETECTION", "FACE_DETECTION", "OBJECT_TRACKING"]
+        if not value_allowed_none_or_none_sentinel(feature_type, allowed_values):
+            feature_type = 'UNKNOWN_ENUM_VALUE'
+        self._feature_type = feature_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