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

oci/generative_ai_agent/models/create_tool_details.py

@@ -0,0 +1,307 @@
+# 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 CreateToolDetails(object):
+    """
+    The data to create a Tool.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateToolDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param display_name:
+            The value to assign to the display_name property of this CreateToolDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this CreateToolDetails.
+        :type description: str
+
+        :param agent_id:
+            The value to assign to the agent_id property of this CreateToolDetails.
+        :type agent_id: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this CreateToolDetails.
+        :type compartment_id: str
+
+        :param tool_config:
+            The value to assign to the tool_config property of this CreateToolDetails.
+        :type tool_config: oci.generative_ai_agent.models.ToolConfig
+
+        :param metadata:
+            The value to assign to the metadata property of this CreateToolDetails.
+        :type metadata: dict(str, str)
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this CreateToolDetails.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this CreateToolDetails.
+        :type defined_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'display_name': 'str',
+            'description': 'str',
+            'agent_id': 'str',
+            'compartment_id': 'str',
+            'tool_config': 'ToolConfig',
+            'metadata': 'dict(str, str)',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))'
+        }
+        self.attribute_map = {
+            'display_name': 'displayName',
+            'description': 'description',
+            'agent_id': 'agentId',
+            'compartment_id': 'compartmentId',
+            'tool_config': 'toolConfig',
+            'metadata': 'metadata',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags'
+        }
+        self._display_name = None
+        self._description = None
+        self._agent_id = None
+        self._compartment_id = None
+        self._tool_config = None
+        self._metadata = None
+        self._freeform_tags = None
+        self._defined_tags = None
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this CreateToolDetails.
+        A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
+
+
+        :return: The display_name of this CreateToolDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this CreateToolDetails.
+        A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
+
+
+        :param display_name: The display_name of this CreateToolDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        **[Required]** Gets the description of this CreateToolDetails.
+        Description about the Tool.
+
+
+        :return: The description of this CreateToolDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateToolDetails.
+        Description about the Tool.
+
+
+        :param description: The description of this CreateToolDetails.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def agent_id(self):
+        """
+        **[Required]** Gets the agent_id of this CreateToolDetails.
+        The OCID of the agent that this Tool is attached to.
+
+
+        :return: The agent_id of this CreateToolDetails.
+        :rtype: str
+        """
+        return self._agent_id
+
+    @agent_id.setter
+    def agent_id(self, agent_id):
+        """
+        Sets the agent_id of this CreateToolDetails.
+        The OCID of the agent that this Tool is attached to.
+
+
+        :param agent_id: The agent_id of this CreateToolDetails.
+        :type: str
+        """
+        self._agent_id = agent_id
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this CreateToolDetails.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this CreateToolDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this CreateToolDetails.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this CreateToolDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def tool_config(self):
+        """
+        **[Required]** Gets the tool_config of this CreateToolDetails.
+
+        :return: The tool_config of this CreateToolDetails.
+        :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 CreateToolDetails.
+
+        :param tool_config: The tool_config of this CreateToolDetails.
+        :type: oci.generative_ai_agent.models.ToolConfig
+        """
+        self._tool_config = tool_config
+
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this CreateToolDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :return: The metadata of this CreateToolDetails.
+        :rtype: dict(str, str)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this CreateToolDetails.
+        Key-value pairs to allow additional configurations.
+
+
+        :param metadata: The metadata of this CreateToolDetails.
+        :type: dict(str, str)
+        """
+        self._metadata = metadata
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this CreateToolDetails.
+        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 CreateToolDetails.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this CreateToolDetails.
+        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 CreateToolDetails.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this CreateToolDetails.
+        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 CreateToolDetails.
+        :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 CreateToolDetails.
+        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 CreateToolDetails.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_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/data_source.py

@@ -76,6 +76,10 @@ class DataSource(object):
             The value to assign to the data_source_config property of this DataSource.
         :type data_source_config: oci.generative_ai_agent.models.DataSourceConfig
 
+        :param metadata:
+            The value to assign to the metadata property of this DataSource.
+        :type metadata: dict(str, str)
+
         :param time_created:
             The value to assign to the time_created property of this DataSource.
         :type time_created: datetime
@@ -114,6 +118,7 @@ class DataSource(object):
             'compartment_id': 'str',
             'knowledge_base_id': 'str',
             'data_source_config': 'DataSourceConfig',
+            'metadata': 'dict(str, str)',
             'time_created': 'datetime',
             'time_updated': 'datetime',
             'lifecycle_state': 'str',
@@ -129,6 +134,7 @@ class DataSource(object):
             'compartment_id': 'compartmentId',
             'knowledge_base_id': 'knowledgeBaseId',
             'data_source_config': 'dataSourceConfig',
+            'metadata': 'metadata',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
             'lifecycle_state': 'lifecycleState',
@@ -143,6 +149,7 @@ class DataSource(object):
         self._compartment_id = None
         self._knowledge_base_id = None
         self._data_source_config = None
+        self._metadata = None
         self._time_created = None
         self._time_updated = None
         self._lifecycle_state = None
@@ -303,6 +310,30 @@ class DataSource(object):
         """
         self._data_source_config = data_source_config
 
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this DataSource.
+        Key-value pairs to allow additional configurations.
+
+
+        :return: The metadata of this DataSource.
+        :rtype: dict(str, str)
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this DataSource.
+        Key-value pairs to allow additional configurations.
+
+
+        :param metadata: The metadata of this DataSource.
+        :type: dict(str, str)
+        """
+        self._metadata = metadata
+
     @property
     def time_created(self):
         """

oci/generative_ai_agent/models/function.py

@@ -0,0 +1,134 @@
+# 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 Function(object):
+    """
+    Details of Function for Function calling tool.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Function 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 Function.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this Function.
+        :type description: str
+
+        :param parameters:
+            The value to assign to the parameters property of this Function.
+        :type parameters: dict(str, str)
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'description': 'str',
+            'parameters': 'dict(str, str)'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'description': 'description',
+            'parameters': 'parameters'
+        }
+        self._name = None
+        self._description = None
+        self._parameters = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this Function.
+        The name of the function to invoke.
+
+
+        :return: The name of this Function.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this Function.
+        The name of the function to invoke.
+
+
+        :param name: The name of this Function.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this Function.
+        A description of the function.
+
+
+        :return: The description of this Function.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this Function.
+        A description of the function.
+
+
+        :param description: The description of this Function.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def parameters(self):
+        """
+        Gets the parameters of this Function.
+        The parameters the function accepts, defined using a JSON Schema object.
+        Refer to the guide for examples and the JSON Schema documentation for details on the format.
+
+
+        :return: The parameters of this Function.
+        :rtype: dict(str, str)
+        """
+        return self._parameters
+
+    @parameters.setter
+    def parameters(self, parameters):
+        """
+        Sets the parameters of this Function.
+        The parameters the function accepts, defined using a JSON Schema object.
+        Refer to the guide for examples and the JSON Schema documentation for details on the format.
+
+
+        :param parameters: The parameters of this Function.
+        :type: dict(str, str)
+        """
+        self._parameters = parameters
+
+    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/function_calling_tool_config.py

@@ -0,0 +1,76 @@
+# 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 .tool_config import ToolConfig
+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 FunctionCallingToolConfig(ToolConfig):
+    """
+    The configuration for Function calling Tool.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FunctionCallingToolConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_agent.models.FunctionCallingToolConfig.tool_config_type` attribute
+        of this class is ``FUNCTION_CALLING_TOOL_CONFIG`` and it should not be changed.
+        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 FunctionCallingToolConfig.
+            Allowed values for this property are: "SQL_TOOL_CONFIG", "RAG_TOOL_CONFIG", "FUNCTION_CALLING_TOOL_CONFIG", "HTTP_ENDPOINT_TOOL_CONFIG"
+        :type tool_config_type: str
+
+        :param function:
+            The value to assign to the function property of this FunctionCallingToolConfig.
+        :type function: oci.generative_ai_agent.models.Function
+
+        """
+        self.swagger_types = {
+            'tool_config_type': 'str',
+            'function': 'Function'
+        }
+        self.attribute_map = {
+            'tool_config_type': 'toolConfigType',
+            'function': 'function'
+        }
+        self._tool_config_type = None
+        self._function = None
+        self._tool_config_type = 'FUNCTION_CALLING_TOOL_CONFIG'
+
+    @property
+    def function(self):
+        """
+        **[Required]** Gets the function of this FunctionCallingToolConfig.
+
+        :return: The function of this FunctionCallingToolConfig.
+        :rtype: oci.generative_ai_agent.models.Function
+        """
+        return self._function
+
+    @function.setter
+    def function(self, function):
+        """
+        Sets the function of this FunctionCallingToolConfig.
+
+        :param function: The function of this FunctionCallingToolConfig.
+        :type: oci.generative_ai_agent.models.Function
+        """
+        self._function = function
+
+    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