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

oci/generative_ai_inference/models/apply_guardrails_details.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 ApplyGuardrailsDetails(object):
+    """
+    Details for applying guardrails to the input text.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ApplyGuardrailsDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param input:
+            The value to assign to the input property of this ApplyGuardrailsDetails.
+        :type input: oci.generative_ai_inference.models.GuardrailsInput
+
+        :param guardrail_configs:
+            The value to assign to the guardrail_configs property of this ApplyGuardrailsDetails.
+        :type guardrail_configs: oci.generative_ai_inference.models.GuardrailConfigs
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this ApplyGuardrailsDetails.
+        :type compartment_id: str
+
+        """
+        self.swagger_types = {
+            'input': 'GuardrailsInput',
+            'guardrail_configs': 'GuardrailConfigs',
+            'compartment_id': 'str'
+        }
+        self.attribute_map = {
+            'input': 'input',
+            'guardrail_configs': 'guardrailConfigs',
+            'compartment_id': 'compartmentId'
+        }
+        self._input = None
+        self._guardrail_configs = None
+        self._compartment_id = None
+
+    @property
+    def input(self):
+        """
+        **[Required]** Gets the input of this ApplyGuardrailsDetails.
+
+        :return: The input of this ApplyGuardrailsDetails.
+        :rtype: oci.generative_ai_inference.models.GuardrailsInput
+        """
+        return self._input
+
+    @input.setter
+    def input(self, input):
+        """
+        Sets the input of this ApplyGuardrailsDetails.
+
+        :param input: The input of this ApplyGuardrailsDetails.
+        :type: oci.generative_ai_inference.models.GuardrailsInput
+        """
+        self._input = input
+
+    @property
+    def guardrail_configs(self):
+        """
+        **[Required]** Gets the guardrail_configs of this ApplyGuardrailsDetails.
+
+        :return: The guardrail_configs of this ApplyGuardrailsDetails.
+        :rtype: oci.generative_ai_inference.models.GuardrailConfigs
+        """
+        return self._guardrail_configs
+
+    @guardrail_configs.setter
+    def guardrail_configs(self, guardrail_configs):
+        """
+        Sets the guardrail_configs of this ApplyGuardrailsDetails.
+
+        :param guardrail_configs: The guardrail_configs of this ApplyGuardrailsDetails.
+        :type: oci.generative_ai_inference.models.GuardrailConfigs
+        """
+        self._guardrail_configs = guardrail_configs
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this ApplyGuardrailsDetails.
+        The OCID of the compartment to apply guardrails.
+
+
+        :return: The compartment_id of this ApplyGuardrailsDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this ApplyGuardrailsDetails.
+        The OCID of the compartment to apply guardrails.
+
+
+        :param compartment_id: The compartment_id of this ApplyGuardrailsDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    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/apply_guardrails_result.py

@@ -0,0 +1,66 @@
+# 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 ApplyGuardrailsResult(object):
+    """
+    The result of applying guardrails to the input text.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ApplyGuardrailsResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param results:
+            The value to assign to the results property of this ApplyGuardrailsResult.
+        :type results: oci.generative_ai_inference.models.GuardrailsResults
+
+        """
+        self.swagger_types = {
+            'results': 'GuardrailsResults'
+        }
+        self.attribute_map = {
+            'results': 'results'
+        }
+        self._results = None
+
+    @property
+    def results(self):
+        """
+        **[Required]** Gets the results of this ApplyGuardrailsResult.
+
+        :return: The results of this ApplyGuardrailsResult.
+        :rtype: oci.generative_ai_inference.models.GuardrailsResults
+        """
+        return self._results
+
+    @results.setter
+    def results(self, results):
+        """
+        Sets the results of this ApplyGuardrailsResult.
+
+        :param results: The results of this ApplyGuardrailsResult.
+        :type: oci.generative_ai_inference.models.GuardrailsResults
+        """
+        self._results = results
+
+    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/assistant_message.py

@@ -13,6 +13,9 @@ from oci.decorators import init_model_state_from_kwargs
 class AssistantMessage(Message):
     """
     Represents a single instance of assistant message.
+
+    Note: When responding to a tool call, set `content` to `null` (not `\"\"`).
+    This ensures the model correctly processes tool call messages in multi-step interactions.
     """
 
     def __init__(self, **kwargs):

oci/generative_ai_inference/models/category_score.py

@@ -0,0 +1,101 @@
+# 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 CategoryScore(object):
+    """
+    A category with its score.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CategoryScore object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param name:
+            The value to assign to the name property of this CategoryScore.
+        :type name: str
+
+        :param score:
+            The value to assign to the score property of this CategoryScore.
+        :type score: float
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'score': 'float'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'score': 'score'
+        }
+        self._name = None
+        self._score = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this CategoryScore.
+        The name of the category.
+
+
+        :return: The name of this CategoryScore.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this CategoryScore.
+        The name of the category.
+
+
+        :param name: The name of this CategoryScore.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def score(self):
+        """
+        **[Required]** Gets the score of this CategoryScore.
+        The score of the category.
+
+
+        :return: The score of this CategoryScore.
+        :rtype: float
+        """
+        return self._score
+
+    @score.setter
+    def score(self, score):
+        """
+        Sets the score of this CategoryScore.
+        The score of the category.
+
+
+        :param score: The score of this CategoryScore.
+        :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/cohere_chat_request.py

@@ -31,6 +31,18 @@ class CohereChatRequest(BaseChatRequest):
     #: This constant has a value of "FAST"
     CITATION_QUALITY_FAST = "FAST"
 
+    #: A constant which can be used with the safety_mode property of a CohereChatRequest.
+    #: This constant has a value of "CONTEXTUAL"
+    SAFETY_MODE_CONTEXTUAL = "CONTEXTUAL"
+
+    #: A constant which can be used with the safety_mode property of a CohereChatRequest.
+    #: This constant has a value of "STRICT"
+    SAFETY_MODE_STRICT = "STRICT"
+
+    #: A constant which can be used with the safety_mode property of a CohereChatRequest.
+    #: This constant has a value of "OFF"
+    SAFETY_MODE_OFF = "OFF"
+
     def __init__(self, **kwargs):
         """
         Initializes a new CohereChatRequest object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereChatRequest.api_format` attribute
@@ -136,6 +148,11 @@ class CohereChatRequest(BaseChatRequest):
             Allowed values for this property are: "ACCURATE", "FAST"
         :type citation_quality: str
 
+        :param safety_mode:
+            The value to assign to the safety_mode property of this CohereChatRequest.
+            Allowed values for this property are: "CONTEXTUAL", "STRICT", "OFF"
+        :type safety_mode: str
+
         """
         self.swagger_types = {
             'api_format': 'str',
@@ -161,7 +178,8 @@ class CohereChatRequest(BaseChatRequest):
             'is_force_single_step': 'bool',
             'stop_sequences': 'list[str]',
             'is_raw_prompting': 'bool',
-            'citation_quality': 'str'
+            'citation_quality': 'str',
+            'safety_mode': 'str'
         }
         self.attribute_map = {
             'api_format': 'apiFormat',
@@ -187,7 +205,8 @@ class CohereChatRequest(BaseChatRequest):
             'is_force_single_step': 'isForceSingleStep',
             'stop_sequences': 'stopSequences',
             'is_raw_prompting': 'isRawPrompting',
-            'citation_quality': 'citationQuality'
+            'citation_quality': 'citationQuality',
+            'safety_mode': 'safetyMode'
         }
         self._api_format = None
         self._message = None
@@ -213,6 +232,7 @@ class CohereChatRequest(BaseChatRequest):
         self._stop_sequences = None
         self._is_raw_prompting = None
         self._citation_quality = None
+        self._safety_mode = None
         self._api_format = 'COHERE'
 
     @property
@@ -809,6 +829,37 @@ class CohereChatRequest(BaseChatRequest):
             )
         self._citation_quality = citation_quality
 
+    @property
+    def safety_mode(self):
+        """
+        Gets the safety_mode of this CohereChatRequest.
+        Used to select the safety instruction inserted into the prompt. When selected CONTEXTUAL mode, It is appropriate for wide-ranging interactions with fewer constraints on output while maintaining core protections by rejecting harmful or illegal suggestions. When selected STRICT mode, it aims to avoid all sensitive topics, such as violent or sexual acts and profanity. When selected OFF, the safety instruction will be omitted. Note: This parameter is only compatible with models Command R 08-2024, Command R+ 08-2024 and newer. Also, command-r7b-12-2024 only supports \"CONTEXTUAL\" and \"STRICT\" modes.
+
+        Allowed values for this property are: "CONTEXTUAL", "STRICT", "OFF"
+
+
+        :return: The safety_mode of this CohereChatRequest.
+        :rtype: str
+        """
+        return self._safety_mode
+
+    @safety_mode.setter
+    def safety_mode(self, safety_mode):
+        """
+        Sets the safety_mode of this CohereChatRequest.
+        Used to select the safety instruction inserted into the prompt. When selected CONTEXTUAL mode, It is appropriate for wide-ranging interactions with fewer constraints on output while maintaining core protections by rejecting harmful or illegal suggestions. When selected STRICT mode, it aims to avoid all sensitive topics, such as violent or sexual acts and profanity. When selected OFF, the safety instruction will be omitted. Note: This parameter is only compatible with models Command R 08-2024, Command R+ 08-2024 and newer. Also, command-r7b-12-2024 only supports \"CONTEXTUAL\" and \"STRICT\" modes.
+
+
+        :param safety_mode: The safety_mode of this CohereChatRequest.
+        :type: str
+        """
+        allowed_values = ["CONTEXTUAL", "STRICT", "OFF"]
+        if not value_allowed_none_or_none_sentinel(safety_mode, allowed_values):
+            raise ValueError(
+                f"Invalid value for `safety_mode`, must be None or one of {allowed_values}"
+            )
+        self._safety_mode = safety_mode
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/generative_ai_inference/models/content_moderation_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 ContentModerationConfiguration(object):
+    """
+    Configuration for content moderation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ContentModerationConfiguration object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param categories:
+            The value to assign to the categories property of this ContentModerationConfiguration.
+        :type categories: list[str]
+
+        """
+        self.swagger_types = {
+            'categories': 'list[str]'
+        }
+        self.attribute_map = {
+            'categories': 'categories'
+        }
+        self._categories = None
+
+    @property
+    def categories(self):
+        """
+        **[Required]** Gets the categories of this ContentModerationConfiguration.
+        The categories to detect in the input text.
+
+
+        :return: The categories of this ContentModerationConfiguration.
+        :rtype: list[str]
+        """
+        return self._categories
+
+    @categories.setter
+    def categories(self, categories):
+        """
+        Sets the categories of this ContentModerationConfiguration.
+        The categories to detect in the input text.
+
+
+        :param categories: The categories of this ContentModerationConfiguration.
+        :type: list[str]
+        """
+        self._categories = categories
+
+    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/content_moderation_result.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 ContentModerationResult(object):
+    """
+    The result of content moderation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ContentModerationResult object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param categories:
+            The value to assign to the categories property of this ContentModerationResult.
+        :type categories: list[oci.generative_ai_inference.models.CategoryScore]
+
+        """
+        self.swagger_types = {
+            'categories': 'list[CategoryScore]'
+        }
+        self.attribute_map = {
+            'categories': 'categories'
+        }
+        self._categories = None
+
+    @property
+    def categories(self):
+        """
+        **[Required]** Gets the categories of this ContentModerationResult.
+        A list of categories with their respective scores.
+
+
+        :return: The categories of this ContentModerationResult.
+        :rtype: list[oci.generative_ai_inference.models.CategoryScore]
+        """
+        return self._categories
+
+    @categories.setter
+    def categories(self, categories):
+        """
+        Sets the categories of this ContentModerationResult.
+        A list of categories with their respective scores.
+
+
+        :param categories: The categories of this ContentModerationResult.
+        :type: list[oci.generative_ai_inference.models.CategoryScore]
+        """
+        self._categories = categories
+
+    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/guardrail_configs.py

@@ -0,0 +1,120 @@
+# 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 GuardrailConfigs(object):
+    """
+    Additional configuration for each guardrail.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GuardrailConfigs object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param content_moderation_config:
+            The value to assign to the content_moderation_config property of this GuardrailConfigs.
+        :type content_moderation_config: oci.generative_ai_inference.models.ContentModerationConfiguration
+
+        :param personally_identifiable_information_config:
+            The value to assign to the personally_identifiable_information_config property of this GuardrailConfigs.
+        :type personally_identifiable_information_config: oci.generative_ai_inference.models.PersonallyIdentifiableInformationConfiguration
+
+        :param prompt_injection_config:
+            The value to assign to the prompt_injection_config property of this GuardrailConfigs.
+        :type prompt_injection_config: oci.generative_ai_inference.models.PromptInjectionConfiguration
+
+        """
+        self.swagger_types = {
+            'content_moderation_config': 'ContentModerationConfiguration',
+            'personally_identifiable_information_config': 'PersonallyIdentifiableInformationConfiguration',
+            'prompt_injection_config': 'PromptInjectionConfiguration'
+        }
+        self.attribute_map = {
+            'content_moderation_config': 'contentModerationConfig',
+            'personally_identifiable_information_config': 'personallyIdentifiableInformationConfig',
+            'prompt_injection_config': 'promptInjectionConfig'
+        }
+        self._content_moderation_config = None
+        self._personally_identifiable_information_config = None
+        self._prompt_injection_config = None
+
+    @property
+    def content_moderation_config(self):
+        """
+        Gets the content_moderation_config of this GuardrailConfigs.
+
+        :return: The content_moderation_config of this GuardrailConfigs.
+        :rtype: oci.generative_ai_inference.models.ContentModerationConfiguration
+        """
+        return self._content_moderation_config
+
+    @content_moderation_config.setter
+    def content_moderation_config(self, content_moderation_config):
+        """
+        Sets the content_moderation_config of this GuardrailConfigs.
+
+        :param content_moderation_config: The content_moderation_config of this GuardrailConfigs.
+        :type: oci.generative_ai_inference.models.ContentModerationConfiguration
+        """
+        self._content_moderation_config = content_moderation_config
+
+    @property
+    def personally_identifiable_information_config(self):
+        """
+        Gets the personally_identifiable_information_config of this GuardrailConfigs.
+
+        :return: The personally_identifiable_information_config of this GuardrailConfigs.
+        :rtype: oci.generative_ai_inference.models.PersonallyIdentifiableInformationConfiguration
+        """
+        return self._personally_identifiable_information_config
+
+    @personally_identifiable_information_config.setter
+    def personally_identifiable_information_config(self, personally_identifiable_information_config):
+        """
+        Sets the personally_identifiable_information_config of this GuardrailConfigs.
+
+        :param personally_identifiable_information_config: The personally_identifiable_information_config of this GuardrailConfigs.
+        :type: oci.generative_ai_inference.models.PersonallyIdentifiableInformationConfiguration
+        """
+        self._personally_identifiable_information_config = personally_identifiable_information_config
+
+    @property
+    def prompt_injection_config(self):
+        """
+        Gets the prompt_injection_config of this GuardrailConfigs.
+
+        :return: The prompt_injection_config of this GuardrailConfigs.
+        :rtype: oci.generative_ai_inference.models.PromptInjectionConfiguration
+        """
+        return self._prompt_injection_config
+
+    @prompt_injection_config.setter
+    def prompt_injection_config(self, prompt_injection_config):
+        """
+        Sets the prompt_injection_config of this GuardrailConfigs.
+
+        :param prompt_injection_config: The prompt_injection_config of this GuardrailConfigs.
+        :type: oci.generative_ai_inference.models.PromptInjectionConfiguration
+        """
+        self._prompt_injection_config = prompt_injection_config
+
+    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