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

oci/generative_ai_agent/models/tool_config.py

@@ -0,0 +1,133 @@
+# 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 ToolConfig(object):
+    """
+    The configuration and type of Tool.
+    """
+
+    #: A constant which can be used with the tool_config_type property of a ToolConfig.
+    #: This constant has a value of "SQL_TOOL_CONFIG"
+    TOOL_CONFIG_TYPE_SQL_TOOL_CONFIG = "SQL_TOOL_CONFIG"
+
+    #: A constant which can be used with the tool_config_type property of a ToolConfig.
+    #: This constant has a value of "RAG_TOOL_CONFIG"
+    TOOL_CONFIG_TYPE_RAG_TOOL_CONFIG = "RAG_TOOL_CONFIG"
+
+    #: A constant which can be used with the tool_config_type property of a ToolConfig.
+    #: This constant has a value of "FUNCTION_CALLING_TOOL_CONFIG"
+    TOOL_CONFIG_TYPE_FUNCTION_CALLING_TOOL_CONFIG = "FUNCTION_CALLING_TOOL_CONFIG"
+
+    #: A constant which can be used with the tool_config_type property of a ToolConfig.
+    #: This constant has a value of "HTTP_ENDPOINT_TOOL_CONFIG"
+    TOOL_CONFIG_TYPE_HTTP_ENDPOINT_TOOL_CONFIG = "HTTP_ENDPOINT_TOOL_CONFIG"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolConfig 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_agent.models.SqlToolConfig`
+        * :class:`~oci.generative_ai_agent.models.FunctionCallingToolConfig`
+        * :class:`~oci.generative_ai_agent.models.HttpEndpointToolConfig`
+        * :class:`~oci.generative_ai_agent.models.RagToolConfig`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param tool_config_type:
+            The value to assign to the tool_config_type property of this ToolConfig.
+            Allowed values for this property are: "SQL_TOOL_CONFIG", "RAG_TOOL_CONFIG", "FUNCTION_CALLING_TOOL_CONFIG", "HTTP_ENDPOINT_TOOL_CONFIG", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type tool_config_type: str
+
+        """
+        self.swagger_types = {
+            'tool_config_type': 'str'
+        }
+        self.attribute_map = {
+            'tool_config_type': 'toolConfigType'
+        }
+        self._tool_config_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['toolConfigType']
+
+        if type == 'SQL_TOOL_CONFIG':
+            return 'SqlToolConfig'
+
+        if type == 'FUNCTION_CALLING_TOOL_CONFIG':
+            return 'FunctionCallingToolConfig'
+
+        if type == 'HTTP_ENDPOINT_TOOL_CONFIG':
+            return 'HttpEndpointToolConfig'
+
+        if type == 'RAG_TOOL_CONFIG':
+            return 'RagToolConfig'
+        else:
+            return 'ToolConfig'
+
+    @property
+    def tool_config_type(self):
+        """
+        **[Required]** Gets the tool_config_type of this ToolConfig.
+        The type of the Tool config.
+        The allowed values are:
+        - `SQL_TOOL_CONFIG`: The config for sql Tool.
+        - `RAG_TOOL_CONFIG`: The config for rag Tool.
+        - FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
+        - HTTP_ENDPOINT_TOOL_CONFIG: The config for HTTP endpoint Tool.
+
+        Allowed values for this property are: "SQL_TOOL_CONFIG", "RAG_TOOL_CONFIG", "FUNCTION_CALLING_TOOL_CONFIG", "HTTP_ENDPOINT_TOOL_CONFIG", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The tool_config_type of this ToolConfig.
+        :rtype: str
+        """
+        return self._tool_config_type
+
+    @tool_config_type.setter
+    def tool_config_type(self, tool_config_type):
+        """
+        Sets the tool_config_type of this ToolConfig.
+        The type of the Tool config.
+        The allowed values are:
+        - `SQL_TOOL_CONFIG`: The config for sql Tool.
+        - `RAG_TOOL_CONFIG`: The config for rag Tool.
+        - FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
+        - HTTP_ENDPOINT_TOOL_CONFIG: The config for HTTP endpoint Tool.
+
+
+        :param tool_config_type: The tool_config_type of this ToolConfig.
+        :type: str
+        """
+        allowed_values = ["SQL_TOOL_CONFIG", "RAG_TOOL_CONFIG", "FUNCTION_CALLING_TOOL_CONFIG", "HTTP_ENDPOINT_TOOL_CONFIG"]
+        if not value_allowed_none_or_none_sentinel(tool_config_type, allowed_values):
+            tool_config_type = 'UNKNOWN_ENUM_VALUE'
+        self._tool_config_type = tool_config_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_agent/models/tool_summary.py

@@ -0,0 +1,486 @@
+# 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 ToolSummary(object):
+    """
+    Summary information of a Tool.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ToolSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this ToolSummary.
+        :type id: str
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this ToolSummary.
+        :type lifecycle_state: str
+
+        :param time_created:
+            The value to assign to the time_created property of this ToolSummary.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this ToolSummary.
+        :type time_updated: datetime
+
+        :param display_name:
+            The value to assign to the display_name property of this ToolSummary.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this ToolSummary.
+        :type description: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this ToolSummary.
+        :type compartment_id: str
+
+        :param agent_id:
+            The value to assign to the agent_id property of this ToolSummary.
+        :type agent_id: str
+
+        :param tool_config:
+            The value to assign to the tool_config property of this ToolSummary.
+        :type tool_config: oci.generative_ai_agent.models.ToolConfig
+
+        :param metadata:
+            The value to assign to the metadata property of this ToolSummary.
+        :type metadata: dict(str, str)
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this ToolSummary.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this ToolSummary.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this ToolSummary.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'lifecycle_state': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'display_name': 'str',
+            'description': 'str',
+            'compartment_id': 'str',
+            'agent_id': 'str',
+            'tool_config': 'ToolConfig',
+            'metadata': 'dict(str, str)',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))'
+        }
+        self.attribute_map = {
+            'id': 'id',
+            'lifecycle_state': 'lifecycleState',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'display_name': 'displayName',
+            'description': 'description',
+            'compartment_id': 'compartmentId',
+            'agent_id': 'agentId',
+            'tool_config': 'toolConfig',
+            'metadata': 'metadata',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+        self._id = None
+        self._lifecycle_state = None
+        self._time_created = None
+        self._time_updated = None
+        self._display_name = None
+        self._description = None
+        self._compartment_id = None
+        self._agent_id = None
+        self._tool_config = None
+        self._metadata = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this ToolSummary.
+        The `OCID`__ of the Tool.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this ToolSummary.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this ToolSummary.
+        The `OCID`__ of the Tool.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this ToolSummary.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this ToolSummary.
+        The current state of the agent.
+
+
+        :return: The lifecycle_state of this ToolSummary.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this ToolSummary.
+        The current state of the agent.
+
+
+        :param lifecycle_state: The lifecycle_state of this ToolSummary.
+        :type: str
+        """
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this ToolSummary.
+        The date and time the Tool was created, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_created of this ToolSummary.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this ToolSummary.
+        The date and time the Tool was created, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_created: The time_created of this ToolSummary.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        Gets the time_updated of this ToolSummary.
+        The date and time the Tool was updated, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :return: The time_updated of this ToolSummary.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this ToolSummary.
+        The date and time the Tool was updated, in the format defined by `RFC 3339`__.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/html/rfc3339
+
+
+        :param time_updated: The time_updated of this ToolSummary.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this ToolSummary.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this ToolSummary.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this ToolSummary.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this ToolSummary.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this ToolSummary.
+        Description about the Tool.
+
+
+        :return: The description of this ToolSummary.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this ToolSummary.
+        Description about the Tool.
+
+
+        :param description: The description of this ToolSummary.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this ToolSummary.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this ToolSummary.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this ToolSummary.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this ToolSummary.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def agent_id(self):
+        """
+        **[Required]** Gets the agent_id of this ToolSummary.
+        The OCID of the agent that this Tool is attached to.
+
+
+        :return: The agent_id of this ToolSummary.
+        :rtype: str
+        """
+        return self._agent_id
+
+    @agent_id.setter
+    def agent_id(self, agent_id):
+        """
+        Sets the agent_id of this ToolSummary.
+        The OCID of the agent that this Tool is attached to.
+
+
+        :param agent_id: The agent_id of this ToolSummary.
+        :type: str
+        """
+        self._agent_id = agent_id
+
+    @property
+    def tool_config(self):
+        """
+        **[Required]** Gets the tool_config of this ToolSummary.
+
+        :return: The tool_config of this ToolSummary.
+        :rtype: oci.generative_ai_agent.models.ToolConfig
+        """
+        return self._tool_config
+
+    @tool_config.setter
+    def tool_config(self, tool_config):
+        """
+        Sets the tool_config of this ToolSummary.
+
+        :param tool_config: The tool_config of this ToolSummary.
+        :type: oci.generative_ai_agent.models.ToolConfig
+        """
+        self._tool_config = tool_config
+
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this ToolSummary.
+        Key-value pairs to allow additional configurations.
+
+
+        :return: The metadata of this ToolSummary.
+        :rtype: dict(str, str)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this ToolSummary.
+        Key-value pairs to allow additional configurations.
+
+
+        :param metadata: The metadata of this ToolSummary.
+        :type: dict(str, str)
+        """
+        self._metadata = metadata
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this ToolSummary.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The freeform_tags of this ToolSummary.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this ToolSummary.
+        Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Department\": \"Finance\"}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param freeform_tags: The freeform_tags of this ToolSummary.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this ToolSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The defined_tags of this ToolSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._defined_tags
+
+    @defined_tags.setter
+    def defined_tags(self, defined_tags):
+        """
+        Sets the defined_tags of this ToolSummary.
+        Defined tags for this resource. Each key is predefined and scoped to a namespace.
+        For more information, see `Resource Tags`__.
+
+        Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param defined_tags: The defined_tags of this ToolSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this ToolSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :return: The system_tags of this ToolSummary.
+        :rtype: dict(str, dict(str, object))
+        """
+        return self._system_tags
+
+    @system_tags.setter
+    def system_tags(self, system_tags):
+        """
+        Sets the system_tags of this ToolSummary.
+        System tags for this resource. Each key is predefined and scoped to a namespace.
+
+        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+
+
+        :param system_tags: The system_tags of this ToolSummary.
+        :type: dict(str, dict(str, object))
+        """
+        self._system_tags = system_tags
+
+    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/update_agent_details.py

@@ -36,6 +36,10 @@ class UpdateAgentDetails(object):
             The value to assign to the welcome_message property of this UpdateAgentDetails.
         :type welcome_message: str
 
+        :param llm_config:
+            The value to assign to the llm_config property of this UpdateAgentDetails.
+        :type llm_config: oci.generative_ai_agent.models.LlmConfig
+
         :param freeform_tags:
             The value to assign to the freeform_tags property of this UpdateAgentDetails.
         :type freeform_tags: dict(str, str)
@@ -50,6 +54,7 @@ class UpdateAgentDetails(object):
             'description': 'str',
             'knowledge_base_ids': 'list[str]',
             'welcome_message': 'str',
+            'llm_config': 'LlmConfig',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))'
         }
@@ -58,6 +63,7 @@ class UpdateAgentDetails(object):
             'description': 'description',
             'knowledge_base_ids': 'knowledgeBaseIds',
             'welcome_message': 'welcomeMessage',
+            'llm_config': 'llmConfig',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags'
         }
@@ -65,6 +71,7 @@ class UpdateAgentDetails(object):
         self._description = None
         self._knowledge_base_ids = None
         self._welcome_message = None
+        self._llm_config = None
         self._freeform_tags = None
         self._defined_tags = None
 
@@ -120,7 +127,7 @@ class UpdateAgentDetails(object):
     def knowledge_base_ids(self):
         """
         Gets the knowledge_base_ids of this UpdateAgentDetails.
-        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
 
@@ -134,7 +141,7 @@ class UpdateAgentDetails(object):
     def knowledge_base_ids(self, knowledge_base_ids):
         """
         Sets the knowledge_base_ids of this UpdateAgentDetails.
-        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
 
@@ -168,6 +175,26 @@ class UpdateAgentDetails(object):
         """
         self._welcome_message = welcome_message
 
+    @property
+    def llm_config(self):
+        """
+        Gets the llm_config of this UpdateAgentDetails.
+
+        :return: The llm_config of this UpdateAgentDetails.
+        :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 UpdateAgentDetails.
+
+        :param llm_config: The llm_config of this UpdateAgentDetails.
+        :type: oci.generative_ai_agent.models.LlmConfig
+        """
+        self._llm_config = llm_config
+
     @property
     def freeform_tags(self):
         """