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

oci/generative_ai_agent/models/content_moderation_guardrail_config.py

@@ -0,0 +1,141 @@
+# 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: 20240531
+
+
+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 ContentModerationGuardrailConfig(object):
+    """
+    The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
+    """
+
+    #: A constant which can be used with the input_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "DISABLE"
+    INPUT_GUARDRAIL_MODE_DISABLE = "DISABLE"
+
+    #: A constant which can be used with the input_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "BLOCK"
+    INPUT_GUARDRAIL_MODE_BLOCK = "BLOCK"
+
+    #: A constant which can be used with the input_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "INFORM"
+    INPUT_GUARDRAIL_MODE_INFORM = "INFORM"
+
+    #: A constant which can be used with the output_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "DISABLE"
+    OUTPUT_GUARDRAIL_MODE_DISABLE = "DISABLE"
+
+    #: A constant which can be used with the output_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "BLOCK"
+    OUTPUT_GUARDRAIL_MODE_BLOCK = "BLOCK"
+
+    #: A constant which can be used with the output_guardrail_mode property of a ContentModerationGuardrailConfig.
+    #: This constant has a value of "INFORM"
+    OUTPUT_GUARDRAIL_MODE_INFORM = "INFORM"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ContentModerationGuardrailConfig object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param input_guardrail_mode:
+            The value to assign to the input_guardrail_mode property of this ContentModerationGuardrailConfig.
+            Allowed values for this property are: "DISABLE", "BLOCK", "INFORM", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type input_guardrail_mode: str
+
+        :param output_guardrail_mode:
+            The value to assign to the output_guardrail_mode property of this ContentModerationGuardrailConfig.
+            Allowed values for this property are: "DISABLE", "BLOCK", "INFORM", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type output_guardrail_mode: str
+
+        """
+        self.swagger_types = {
+            'input_guardrail_mode': 'str',
+            'output_guardrail_mode': 'str'
+        }
+        self.attribute_map = {
+            'input_guardrail_mode': 'inputGuardrailMode',
+            'output_guardrail_mode': 'outputGuardrailMode'
+        }
+        self._input_guardrail_mode = None
+        self._output_guardrail_mode = None
+
+    @property
+    def input_guardrail_mode(self):
+        """
+        Gets the input_guardrail_mode of this ContentModerationGuardrailConfig.
+        An input guardrail mode for content moderation.
+
+        Allowed values for this property are: "DISABLE", "BLOCK", "INFORM", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The input_guardrail_mode of this ContentModerationGuardrailConfig.
+        :rtype: str
+        """
+        return self._input_guardrail_mode
+
+    @input_guardrail_mode.setter
+    def input_guardrail_mode(self, input_guardrail_mode):
+        """
+        Sets the input_guardrail_mode of this ContentModerationGuardrailConfig.
+        An input guardrail mode for content moderation.
+
+
+        :param input_guardrail_mode: The input_guardrail_mode of this ContentModerationGuardrailConfig.
+        :type: str
+        """
+        allowed_values = ["DISABLE", "BLOCK", "INFORM"]
+        if not value_allowed_none_or_none_sentinel(input_guardrail_mode, allowed_values):
+            input_guardrail_mode = 'UNKNOWN_ENUM_VALUE'
+        self._input_guardrail_mode = input_guardrail_mode
+
+    @property
+    def output_guardrail_mode(self):
+        """
+        Gets the output_guardrail_mode of this ContentModerationGuardrailConfig.
+        An output guardrail mode for content moderation.
+
+        Allowed values for this property are: "DISABLE", "BLOCK", "INFORM", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The output_guardrail_mode of this ContentModerationGuardrailConfig.
+        :rtype: str
+        """
+        return self._output_guardrail_mode
+
+    @output_guardrail_mode.setter
+    def output_guardrail_mode(self, output_guardrail_mode):
+        """
+        Sets the output_guardrail_mode of this ContentModerationGuardrailConfig.
+        An output guardrail mode for content moderation.
+
+
+        :param output_guardrail_mode: The output_guardrail_mode of this ContentModerationGuardrailConfig.
+        :type: str
+        """
+        allowed_values = ["DISABLE", "BLOCK", "INFORM"]
+        if not value_allowed_none_or_none_sentinel(output_guardrail_mode, allowed_values):
+            output_guardrail_mode = 'UNKNOWN_ENUM_VALUE'
+        self._output_guardrail_mode = output_guardrail_mode
+
+    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_agent/models/create_agent_details.py

@@ -40,6 +40,10 @@ class CreateAgentDetails(object):
             The value to assign to the welcome_message property of this CreateAgentDetails.
         :type welcome_message: str
 
+        :param llm_config:
+            The value to assign to the llm_config property of this CreateAgentDetails.
+        :type llm_config: oci.generative_ai_agent.models.LlmConfig
+
         :param freeform_tags:
             The value to assign to the freeform_tags property of this CreateAgentDetails.
         :type freeform_tags: dict(str, str)
@@ -55,6 +59,7 @@ class CreateAgentDetails(object):
             'compartment_id': 'str',
             'knowledge_base_ids': 'list[str]',
             'welcome_message': 'str',
+            'llm_config': 'LlmConfig',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))'
         }
@@ -64,6 +69,7 @@ class CreateAgentDetails(object):
             'compartment_id': 'compartmentId',
             'knowledge_base_ids': 'knowledgeBaseIds',
             'welcome_message': 'welcomeMessage',
+            'llm_config': 'llmConfig',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags'
         }
@@ -72,6 +78,7 @@ class CreateAgentDetails(object):
         self._compartment_id = None
         self._knowledge_base_ids = None
         self._welcome_message = None
+        self._llm_config = None
         self._freeform_tags = None
         self._defined_tags = None
 
@@ -155,7 +162,7 @@ class CreateAgentDetails(object):
     def knowledge_base_ids(self):
         """
         Gets the knowledge_base_ids of this CreateAgentDetails.
-        List of `OCID`__ of the knowledgeBases associated with agent.
+        List of `OCID`__ of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
@@ -169,7 +176,7 @@ class CreateAgentDetails(object):
     def knowledge_base_ids(self, knowledge_base_ids):
         """
         Sets the knowledge_base_ids of this CreateAgentDetails.
-        List of `OCID`__ of the knowledgeBases associated with agent.
+        List of `OCID`__ of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.
 
         __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
@@ -203,6 +210,26 @@ class CreateAgentDetails(object):
         """
         self._welcome_message = welcome_message
 
+    @property
+    def llm_config(self):
+        """
+        Gets the llm_config of this CreateAgentDetails.
+
+        :return: The llm_config of this CreateAgentDetails.
+        :rtype: oci.generative_ai_agent.models.LlmConfig
+        """
+        return self._llm_config
+
+    @llm_config.setter
+    def llm_config(self, llm_config):
+        """
+        Sets the llm_config of this CreateAgentDetails.
+
+        :param llm_config: The llm_config of this CreateAgentDetails.
+        :type: oci.generative_ai_agent.models.LlmConfig
+        """
+        self._llm_config = llm_config
+
     @property
     def freeform_tags(self):
         """

oci/generative_ai_agent/models/create_agent_endpoint_details.py

@@ -36,6 +36,22 @@ class CreateAgentEndpointDetails(object):
             The value to assign to the content_moderation_config property of this CreateAgentEndpointDetails.
         :type content_moderation_config: oci.generative_ai_agent.models.ContentModerationConfig
 
+        :param guardrail_config:
+            The value to assign to the guardrail_config property of this CreateAgentEndpointDetails.
+        :type guardrail_config: oci.generative_ai_agent.models.GuardrailConfig
+
+        :param metadata:
+            The value to assign to the metadata property of this CreateAgentEndpointDetails.
+        :type metadata: dict(str, str)
+
+        :param human_input_config:
+            The value to assign to the human_input_config property of this CreateAgentEndpointDetails.
+        :type human_input_config: oci.generative_ai_agent.models.HumanInputConfig
+
+        :param output_config:
+            The value to assign to the output_config property of this CreateAgentEndpointDetails.
+        :type output_config: oci.generative_ai_agent.models.OutputConfig
+
         :param should_enable_trace:
             The value to assign to the should_enable_trace property of this CreateAgentEndpointDetails.
         :type should_enable_trace: bool
@@ -48,6 +64,10 @@ class CreateAgentEndpointDetails(object):
             The value to assign to the should_enable_session property of this CreateAgentEndpointDetails.
         :type should_enable_session: bool
 
+        :param should_enable_multi_language:
+            The value to assign to the should_enable_multi_language property of this CreateAgentEndpointDetails.
+        :type should_enable_multi_language: bool
+
         :param session_config:
             The value to assign to the session_config property of this CreateAgentEndpointDetails.
         :type session_config: oci.generative_ai_agent.models.SessionConfig
@@ -70,9 +90,14 @@ class CreateAgentEndpointDetails(object):
             'description': 'str',
             'agent_id': 'str',
             'content_moderation_config': 'ContentModerationConfig',
+            'guardrail_config': 'GuardrailConfig',
+            'metadata': 'dict(str, str)',
+            'human_input_config': 'HumanInputConfig',
+            'output_config': 'OutputConfig',
             'should_enable_trace': 'bool',
             'should_enable_citation': 'bool',
             'should_enable_session': 'bool',
+            'should_enable_multi_language': 'bool',
             'session_config': 'SessionConfig',
             'compartment_id': 'str',
             'freeform_tags': 'dict(str, str)',
@@ -83,9 +108,14 @@ class CreateAgentEndpointDetails(object):
             'description': 'description',
             'agent_id': 'agentId',
             'content_moderation_config': 'contentModerationConfig',
+            'guardrail_config': 'guardrailConfig',
+            'metadata': 'metadata',
+            'human_input_config': 'humanInputConfig',
+            'output_config': 'outputConfig',
             'should_enable_trace': 'shouldEnableTrace',
             'should_enable_citation': 'shouldEnableCitation',
             'should_enable_session': 'shouldEnableSession',
+            'should_enable_multi_language': 'shouldEnableMultiLanguage',
             'session_config': 'sessionConfig',
             'compartment_id': 'compartmentId',
             'freeform_tags': 'freeformTags',
@@ -95,9 +125,14 @@ class CreateAgentEndpointDetails(object):
         self._description = None
         self._agent_id = None
         self._content_moderation_config = None
+        self._guardrail_config = None
+        self._metadata = None
+        self._human_input_config = None
+        self._output_config = None
         self._should_enable_trace = None
         self._should_enable_citation = None
         self._should_enable_session = None
+        self._should_enable_multi_language = None
         self._session_config = None
         self._compartment_id = None
         self._freeform_tags = None
@@ -195,6 +230,90 @@ class CreateAgentEndpointDetails(object):
         """
         self._content_moderation_config = content_moderation_config
 
+    @property
+    def guardrail_config(self):
+        """
+        Gets the guardrail_config of this CreateAgentEndpointDetails.
+
+        :return: The guardrail_config of this CreateAgentEndpointDetails.
+        :rtype: oci.generative_ai_agent.models.GuardrailConfig
+        """
+        return self._guardrail_config
+
+    @guardrail_config.setter
+    def guardrail_config(self, guardrail_config):
+        """
+        Sets the guardrail_config of this CreateAgentEndpointDetails.
+
+        :param guardrail_config: The guardrail_config of this CreateAgentEndpointDetails.
+        :type: oci.generative_ai_agent.models.GuardrailConfig
+        """
+        self._guardrail_config = guardrail_config
+
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this CreateAgentEndpointDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :return: The metadata of this CreateAgentEndpointDetails.
+        :rtype: dict(str, str)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this CreateAgentEndpointDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :param metadata: The metadata of this CreateAgentEndpointDetails.
+        :type: dict(str, str)
+        """
+        self._metadata = metadata
+
+    @property
+    def human_input_config(self):
+        """
+        Gets the human_input_config of this CreateAgentEndpointDetails.
+
+        :return: The human_input_config of this CreateAgentEndpointDetails.
+        :rtype: oci.generative_ai_agent.models.HumanInputConfig
+        """
+        return self._human_input_config
+
+    @human_input_config.setter
+    def human_input_config(self, human_input_config):
+        """
+        Sets the human_input_config of this CreateAgentEndpointDetails.
+
+        :param human_input_config: The human_input_config of this CreateAgentEndpointDetails.
+        :type: oci.generative_ai_agent.models.HumanInputConfig
+        """
+        self._human_input_config = human_input_config
+
+    @property
+    def output_config(self):
+        """
+        Gets the output_config of this CreateAgentEndpointDetails.
+
+        :return: The output_config of this CreateAgentEndpointDetails.
+        :rtype: oci.generative_ai_agent.models.OutputConfig
+        """
+        return self._output_config
+
+    @output_config.setter
+    def output_config(self, output_config):
+        """
+        Sets the output_config of this CreateAgentEndpointDetails.
+
+        :param output_config: The output_config of this CreateAgentEndpointDetails.
+        :type: oci.generative_ai_agent.models.OutputConfig
+        """
+        self._output_config = output_config
+
     @property
     def should_enable_trace(self):
         """
@@ -267,6 +386,30 @@ class CreateAgentEndpointDetails(object):
         """
         self._should_enable_session = should_enable_session
 
+    @property
+    def should_enable_multi_language(self):
+        """
+        Gets the should_enable_multi_language of this CreateAgentEndpointDetails.
+        Whether to enable multi-language for chat.
+
+
+        :return: The should_enable_multi_language of this CreateAgentEndpointDetails.
+        :rtype: bool
+        """
+        return self._should_enable_multi_language
+
+    @should_enable_multi_language.setter
+    def should_enable_multi_language(self, should_enable_multi_language):
+        """
+        Sets the should_enable_multi_language of this CreateAgentEndpointDetails.
+        Whether to enable multi-language for chat.
+
+
+        :param should_enable_multi_language: The should_enable_multi_language of this CreateAgentEndpointDetails.
+        :type: bool
+        """
+        self._should_enable_multi_language = should_enable_multi_language
+
     @property
     def session_config(self):
         """

oci/generative_ai_agent/models/create_data_source_details.py

@@ -36,6 +36,10 @@ class CreateDataSourceDetails(object):
             The value to assign to the data_source_config property of this CreateDataSourceDetails.
         :type data_source_config: oci.generative_ai_agent.models.DataSourceConfig
 
+        :param metadata:
+            The value to assign to the metadata property of this CreateDataSourceDetails.
+        :type metadata: dict(str, str)
+
         :param compartment_id:
             The value to assign to the compartment_id property of this CreateDataSourceDetails.
         :type compartment_id: str
@@ -54,6 +58,7 @@ class CreateDataSourceDetails(object):
             'description': 'str',
             'knowledge_base_id': 'str',
             'data_source_config': 'DataSourceConfig',
+            'metadata': 'dict(str, str)',
             'compartment_id': 'str',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))'
@@ -63,6 +68,7 @@ class CreateDataSourceDetails(object):
             'description': 'description',
             'knowledge_base_id': 'knowledgeBaseId',
             'data_source_config': 'dataSourceConfig',
+            'metadata': 'metadata',
             'compartment_id': 'compartmentId',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags'
@@ -71,6 +77,7 @@ class CreateDataSourceDetails(object):
         self._description = None
         self._knowledge_base_id = None
         self._data_source_config = None
+        self._metadata = None
         self._compartment_id = None
         self._freeform_tags = None
         self._defined_tags = None
@@ -171,6 +178,30 @@ class CreateDataSourceDetails(object):
         """
         self._data_source_config = data_source_config
 
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this CreateDataSourceDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :return: The metadata of this CreateDataSourceDetails.
+        :rtype: dict(str, str)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this CreateDataSourceDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :param metadata: The metadata of this CreateDataSourceDetails.
+        :type: dict(str, str)
+        """
+        self._metadata = metadata
+
     @property
     def compartment_id(self):
         """