oci 2.149.2__py3-none-any.whl → 2.150.1__py3-none-any.whl

oci/generative_ai_inference/models/guardrails_input.py

@@ -0,0 +1,99 @@
+# 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: 20231130
+
+
+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 GuardrailsInput(object):
+    """
+    The input data for applying guardrails. This can be text, image, video, or audio content.
+    """
+
+    #: A constant which can be used with the type property of a GuardrailsInput.
+    #: This constant has a value of "TEXT"
+    TYPE_TEXT = "TEXT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GuardrailsInput 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.generative_ai_inference.models.GuardrailsTextInput`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this GuardrailsInput.
+            Allowed values for this property are: "TEXT"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'type': 'str'
+        }
+        self.attribute_map = {
+            'type': 'type'
+        }
+        self._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['type']
+
+        if type == 'TEXT':
+            return 'GuardrailsTextInput'
+        else:
+            return 'GuardrailsInput'
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this GuardrailsInput.
+        The type of the input data.
+
+        Allowed values for this property are: "TEXT"
+
+
+        :return: The type of this GuardrailsInput.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this GuardrailsInput.
+        The type of the input data.
+
+
+        :param type: The type of this GuardrailsInput.
+        :type: str
+        """
+        allowed_values = ["TEXT"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `type`, must be None or one of {allowed_values}"
+            )
+        self._type = 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/generative_ai_inference/models/guardrails_results.py

@@ -0,0 +1,124 @@
+# 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: 20231130
+
+
+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 GuardrailsResults(object):
+    """
+    The results of applying each guardrail.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GuardrailsResults object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param content_moderation:
+            The value to assign to the content_moderation property of this GuardrailsResults.
+        :type content_moderation: oci.generative_ai_inference.models.ContentModerationResult
+
+        :param personally_identifiable_information:
+            The value to assign to the personally_identifiable_information property of this GuardrailsResults.
+        :type personally_identifiable_information: list[oci.generative_ai_inference.models.PersonallyIdentifiableInformationResult]
+
+        :param prompt_injection:
+            The value to assign to the prompt_injection property of this GuardrailsResults.
+        :type prompt_injection: oci.generative_ai_inference.models.PromptInjectionProtectionResult
+
+        """
+        self.swagger_types = {
+            'content_moderation': 'ContentModerationResult',
+            'personally_identifiable_information': 'list[PersonallyIdentifiableInformationResult]',
+            'prompt_injection': 'PromptInjectionProtectionResult'
+        }
+        self.attribute_map = {
+            'content_moderation': 'contentModeration',
+            'personally_identifiable_information': 'personallyIdentifiableInformation',
+            'prompt_injection': 'promptInjection'
+        }
+        self._content_moderation = None
+        self._personally_identifiable_information = None
+        self._prompt_injection = None
+
+    @property
+    def content_moderation(self):
+        """
+        Gets the content_moderation of this GuardrailsResults.
+
+        :return: The content_moderation of this GuardrailsResults.
+        :rtype: oci.generative_ai_inference.models.ContentModerationResult
+        """
+        return self._content_moderation
+
+    @content_moderation.setter
+    def content_moderation(self, content_moderation):
+        """
+        Sets the content_moderation of this GuardrailsResults.
+
+        :param content_moderation: The content_moderation of this GuardrailsResults.
+        :type: oci.generative_ai_inference.models.ContentModerationResult
+        """
+        self._content_moderation = content_moderation
+
+    @property
+    def personally_identifiable_information(self):
+        """
+        Gets the personally_identifiable_information of this GuardrailsResults.
+        The result of PII detection
+
+
+        :return: The personally_identifiable_information of this GuardrailsResults.
+        :rtype: list[oci.generative_ai_inference.models.PersonallyIdentifiableInformationResult]
+        """
+        return self._personally_identifiable_information
+
+    @personally_identifiable_information.setter
+    def personally_identifiable_information(self, personally_identifiable_information):
+        """
+        Sets the personally_identifiable_information of this GuardrailsResults.
+        The result of PII detection
+
+
+        :param personally_identifiable_information: The personally_identifiable_information of this GuardrailsResults.
+        :type: list[oci.generative_ai_inference.models.PersonallyIdentifiableInformationResult]
+        """
+        self._personally_identifiable_information = personally_identifiable_information
+
+    @property
+    def prompt_injection(self):
+        """
+        Gets the prompt_injection of this GuardrailsResults.
+
+        :return: The prompt_injection of this GuardrailsResults.
+        :rtype: oci.generative_ai_inference.models.PromptInjectionProtectionResult
+        """
+        return self._prompt_injection
+
+    @prompt_injection.setter
+    def prompt_injection(self, prompt_injection):
+        """
+        Sets the prompt_injection of this GuardrailsResults.
+
+        :param prompt_injection: The prompt_injection of this GuardrailsResults.
+        :type: oci.generative_ai_inference.models.PromptInjectionProtectionResult
+        """
+        self._prompt_injection = prompt_injection
+
+    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/generative_ai_inference/models/guardrails_text_input.py

@@ -0,0 +1,111 @@
+# 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: 20231130
+
+from .guardrails_input import GuardrailsInput
+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 GuardrailsTextInput(GuardrailsInput):
+    """
+    Represents a single instance of text in the guardrails input.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GuardrailsTextInput object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.GuardrailsTextInput.type` attribute
+        of this class is ``TEXT`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this GuardrailsTextInput.
+            Allowed values for this property are: "TEXT"
+        :type type: str
+
+        :param content:
+            The value to assign to the content property of this GuardrailsTextInput.
+        :type content: str
+
+        :param language_code:
+            The value to assign to the language_code property of this GuardrailsTextInput.
+        :type language_code: str
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'content': 'str',
+            'language_code': 'str'
+        }
+        self.attribute_map = {
+            'type': 'type',
+            'content': 'content',
+            'language_code': 'languageCode'
+        }
+        self._type = None
+        self._content = None
+        self._language_code = None
+        self._type = 'TEXT'
+
+    @property
+    def content(self):
+        """
+        Gets the content of this GuardrailsTextInput.
+        The actual input data.
+
+
+        :return: The content of this GuardrailsTextInput.
+        :rtype: str
+        """
+        return self._content
+
+    @content.setter
+    def content(self, content):
+        """
+        Sets the content of this GuardrailsTextInput.
+        The actual input data.
+
+
+        :param content: The content of this GuardrailsTextInput.
+        :type: str
+        """
+        self._content = content
+
+    @property
+    def language_code(self):
+        """
+        Gets the language_code of this GuardrailsTextInput.
+        The language code of the input text. example - en | es | en-US | zh-CN
+
+
+        :return: The language_code of this GuardrailsTextInput.
+        :rtype: str
+        """
+        return self._language_code
+
+    @language_code.setter
+    def language_code(self, language_code):
+        """
+        Sets the language_code of this GuardrailsTextInput.
+        The language code of the input text. example - en | es | en-US | zh-CN
+
+
+        :param language_code: The language_code of this GuardrailsTextInput.
+        :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/generative_ai_inference/models/personally_identifiable_information_configuration.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: 20231130
+
+
+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 PersonallyIdentifiableInformationConfiguration(object):
+    """
+    Configuration for personally identifiable information detection.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PersonallyIdentifiableInformationConfiguration object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param types:
+            The value to assign to the types property of this PersonallyIdentifiableInformationConfiguration.
+        :type types: list[str]
+
+        """
+        self.swagger_types = {
+            'types': 'list[str]'
+        }
+        self.attribute_map = {
+            'types': 'types'
+        }
+        self._types = None
+
+    @property
+    def types(self):
+        """
+        **[Required]** Gets the types of this PersonallyIdentifiableInformationConfiguration.
+        The types of personally identifiable information to detect.
+
+
+        :return: The types of this PersonallyIdentifiableInformationConfiguration.
+        :rtype: list[str]
+        """
+        return self._types
+
+    @types.setter
+    def types(self, types):
+        """
+        Sets the types of this PersonallyIdentifiableInformationConfiguration.
+        The types of personally identifiable information to detect.
+
+
+        :param types: The types of this PersonallyIdentifiableInformationConfiguration.
+        :type: list[str]
+        """
+        self._types = types
+
+    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/generative_ai_inference/models/personally_identifiable_information_result.py

@@ -0,0 +1,194 @@
+# 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: 20231130
+
+
+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 PersonallyIdentifiableInformationResult(object):
+    """
+    An item of personally identifiable information.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PersonallyIdentifiableInformationResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param length:
+            The value to assign to the length property of this PersonallyIdentifiableInformationResult.
+        :type length: int
+
+        :param offset:
+            The value to assign to the offset property of this PersonallyIdentifiableInformationResult.
+        :type offset: int
+
+        :param text:
+            The value to assign to the text property of this PersonallyIdentifiableInformationResult.
+        :type text: str
+
+        :param label:
+            The value to assign to the label property of this PersonallyIdentifiableInformationResult.
+        :type label: str
+
+        :param score:
+            The value to assign to the score property of this PersonallyIdentifiableInformationResult.
+        :type score: float
+
+        """
+        self.swagger_types = {
+            'length': 'int',
+            'offset': 'int',
+            'text': 'str',
+            'label': 'str',
+            'score': 'float'
+        }
+        self.attribute_map = {
+            'length': 'length',
+            'offset': 'offset',
+            'text': 'text',
+            'label': 'label',
+            'score': 'score'
+        }
+        self._length = None
+        self._offset = None
+        self._text = None
+        self._label = None
+        self._score = None
+
+    @property
+    def length(self):
+        """
+        **[Required]** Gets the length of this PersonallyIdentifiableInformationResult.
+        The length of the personally identifiable information.
+
+
+        :return: The length of this PersonallyIdentifiableInformationResult.
+        :rtype: int
+        """
+        return self._length
+
+    @length.setter
+    def length(self, length):
+        """
+        Sets the length of this PersonallyIdentifiableInformationResult.
+        The length of the personally identifiable information.
+
+
+        :param length: The length of this PersonallyIdentifiableInformationResult.
+        :type: int
+        """
+        self._length = length
+
+    @property
+    def offset(self):
+        """
+        **[Required]** Gets the offset of this PersonallyIdentifiableInformationResult.
+        The offset of the personally identifiable information.
+
+
+        :return: The offset of this PersonallyIdentifiableInformationResult.
+        :rtype: int
+        """
+        return self._offset
+
+    @offset.setter
+    def offset(self, offset):
+        """
+        Sets the offset of this PersonallyIdentifiableInformationResult.
+        The offset of the personally identifiable information.
+
+
+        :param offset: The offset of this PersonallyIdentifiableInformationResult.
+        :type: int
+        """
+        self._offset = offset
+
+    @property
+    def text(self):
+        """
+        **[Required]** Gets the text of this PersonallyIdentifiableInformationResult.
+        The text of the personally identifiable information.
+
+
+        :return: The text of this PersonallyIdentifiableInformationResult.
+        :rtype: str
+        """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        """
+        Sets the text of this PersonallyIdentifiableInformationResult.
+        The text of the personally identifiable information.
+
+
+        :param text: The text of this PersonallyIdentifiableInformationResult.
+        :type: str
+        """
+        self._text = text
+
+    @property
+    def label(self):
+        """
+        **[Required]** Gets the label of this PersonallyIdentifiableInformationResult.
+        The label of the personally identifiable information.
+
+
+        :return: The label of this PersonallyIdentifiableInformationResult.
+        :rtype: str
+        """
+        return self._label
+
+    @label.setter
+    def label(self, label):
+        """
+        Sets the label of this PersonallyIdentifiableInformationResult.
+        The label of the personally identifiable information.
+
+
+        :param label: The label of this PersonallyIdentifiableInformationResult.
+        :type: str
+        """
+        self._label = label
+
+    @property
+    def score(self):
+        """
+        **[Required]** Gets the score of this PersonallyIdentifiableInformationResult.
+        The score of the personally identifiable information.
+
+
+        :return: The score of this PersonallyIdentifiableInformationResult.
+        :rtype: float
+        """
+        return self._score
+
+    @score.setter
+    def score(self, score):
+        """
+        Sets the score of this PersonallyIdentifiableInformationResult.
+        The score of the personally identifiable information.
+
+
+        :param score: The score of this PersonallyIdentifiableInformationResult.
+        :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/generative_ai_inference/models/prompt_injection_configuration.py

@@ -0,0 +1,39 @@
+# 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: 20231130
+
+
+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 PromptInjectionConfiguration(object):
+    """
+    Configuration for prompt injection
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PromptInjectionConfiguration object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        """
+        self.swagger_types = {
+        }
+        self.attribute_map = {
+        }
+
+    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