aidp-python-client 1.0.0__py3-none-any.whl

aidp_python_client/aidataplatform_dp/models/nl_to_sql_tool_configuration.py

@@ -0,0 +1,225 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+
+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 NlToSqlToolConfiguration(object):
+    """
+    Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can NOT modify their values
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NlToSqlToolConfiguration object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param catalog_key:
+            The value to assign to the catalog_key property of this NlToSqlToolConfiguration.
+        :type catalog_key: str
+
+        :param schema_key:
+            The value to assign to the schema_key property of this NlToSqlToolConfiguration.
+        :type schema_key: str
+
+        :param tables:
+            The value to assign to the tables property of this NlToSqlToolConfiguration.
+        :type tables: list[str]
+
+        :param columns:
+            The value to assign to the columns property of this NlToSqlToolConfiguration.
+        :type columns: list[str]
+
+        :param in_context_learning:
+            The value to assign to the in_context_learning property of this NlToSqlToolConfiguration.
+        :type in_context_learning: str
+
+        :param additional_instructions:
+            The value to assign to the additional_instructions property of this NlToSqlToolConfiguration.
+        :type additional_instructions: str
+
+        """
+        self.swagger_types = {
+            'catalog_key': 'str',
+            'schema_key': 'str',
+            'tables': 'list[str]',
+            'columns': 'list[str]',
+            'in_context_learning': 'str',
+            'additional_instructions': 'str'
+        }
+
+        self.attribute_map = {
+            'catalog_key': 'catalogKey',
+            'schema_key': 'schemaKey',
+            'tables': 'tables',
+            'columns': 'columns',
+            'in_context_learning': 'inContextLearning',
+            'additional_instructions': 'additionalInstructions'
+        }
+
+        self._catalog_key = None
+        self._schema_key = None
+        self._tables = None
+        self._columns = None
+        self._in_context_learning = None
+        self._additional_instructions = None
+
+    @property
+    def catalog_key(self):
+        """
+        **[Required]** Gets the catalog_key of this NlToSqlToolConfiguration.
+        The Catalog to use for SQL query execution
+
+
+        :return: The catalog_key of this NlToSqlToolConfiguration.
+        :rtype: str
+        """
+        return self._catalog_key
+
+    @catalog_key.setter
+    def catalog_key(self, catalog_key):
+        """
+        Sets the catalog_key of this NlToSqlToolConfiguration.
+        The Catalog to use for SQL query execution
+
+
+        :param catalog_key: The catalog_key of this NlToSqlToolConfiguration.
+        :type: str
+        """
+        self._catalog_key = catalog_key
+
+    @property
+    def schema_key(self):
+        """
+        **[Required]** Gets the schema_key of this NlToSqlToolConfiguration.
+        The Schema to use for SQL query execution
+
+
+        :return: The schema_key of this NlToSqlToolConfiguration.
+        :rtype: str
+        """
+        return self._schema_key
+
+    @schema_key.setter
+    def schema_key(self, schema_key):
+        """
+        Sets the schema_key of this NlToSqlToolConfiguration.
+        The Schema to use for SQL query execution
+
+
+        :param schema_key: The schema_key of this NlToSqlToolConfiguration.
+        :type: str
+        """
+        self._schema_key = schema_key
+
+    @property
+    def tables(self):
+        """
+        **[Required]** Gets the tables of this NlToSqlToolConfiguration.
+        The fully qualified table names to use in SQL query generation
+
+
+        :return: The tables of this NlToSqlToolConfiguration.
+        :rtype: list[str]
+        """
+        return self._tables
+
+    @tables.setter
+    def tables(self, tables):
+        """
+        Sets the tables of this NlToSqlToolConfiguration.
+        The fully qualified table names to use in SQL query generation
+
+
+        :param tables: The tables of this NlToSqlToolConfiguration.
+        :type: list[str]
+        """
+        self._tables = tables
+
+    @property
+    def columns(self):
+        """
+        **[Required]** Gets the columns of this NlToSqlToolConfiguration.
+        The fully qualified column names to use in SQL query generation
+
+
+        :return: The columns of this NlToSqlToolConfiguration.
+        :rtype: list[str]
+        """
+        return self._columns
+
+    @columns.setter
+    def columns(self, columns):
+        """
+        Sets the columns of this NlToSqlToolConfiguration.
+        The fully qualified column names to use in SQL query generation
+
+
+        :param columns: The columns of this NlToSqlToolConfiguration.
+        :type: list[str]
+        """
+        self._columns = columns
+
+    @property
+    def in_context_learning(self):
+        """
+        Gets the in_context_learning of this NlToSqlToolConfiguration.
+        Optional few-shot examples (NL \u2192 SQL pairs) for better generation.
+
+
+        :return: The in_context_learning of this NlToSqlToolConfiguration.
+        :rtype: str
+        """
+        return self._in_context_learning
+
+    @in_context_learning.setter
+    def in_context_learning(self, in_context_learning):
+        """
+        Sets the in_context_learning of this NlToSqlToolConfiguration.
+        Optional few-shot examples (NL \u2192 SQL pairs) for better generation.
+
+
+        :param in_context_learning: The in_context_learning of this NlToSqlToolConfiguration.
+        :type: str
+        """
+        self._in_context_learning = in_context_learning
+
+    @property
+    def additional_instructions(self):
+        """
+        Gets the additional_instructions of this NlToSqlToolConfiguration.
+        Additional instructions that is injected in the system prompt
+
+
+        :return: The additional_instructions of this NlToSqlToolConfiguration.
+        :rtype: str
+        """
+        return self._additional_instructions
+
+    @additional_instructions.setter
+    def additional_instructions(self, additional_instructions):
+        """
+        Sets the additional_instructions of this NlToSqlToolConfiguration.
+        Additional instructions that is injected in the system prompt
+
+
+        :param additional_instructions: The additional_instructions of this NlToSqlToolConfiguration.
+        :type: str
+        """
+        self._additional_instructions = additional_instructions
+
+    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

aidp_python_client/aidataplatform_dp/models/nl_to_sql_tool_input_schema.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+
+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 NlToSqlToolInputSchema(object):
+    """
+    The input schema definition of a NL to SQL Tool
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NlToSqlToolInputSchema object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param query:
+            The value to assign to the query property of this NlToSqlToolInputSchema.
+        :type query: str
+
+        """
+        self.swagger_types = {
+            'query': 'str'
+        }
+
+        self.attribute_map = {
+            'query': 'query'
+        }
+
+        self._query = None
+
+    @property
+    def query(self):
+        """
+        **[Required]** Gets the query of this NlToSqlToolInputSchema.
+        The user question to answer using relevant documents
+
+
+        :return: The query of this NlToSqlToolInputSchema.
+        :rtype: str
+        """
+        return self._query
+
+    @query.setter
+    def query(self, query):
+        """
+        Sets the query of this NlToSqlToolInputSchema.
+        The user question to answer using relevant documents
+
+
+        :param query: The query of this NlToSqlToolInputSchema.
+        :type: str
+        """
+        self._query = query
+
+    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

aidp_python_client/aidataplatform_dp/models/no_auth.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .auth import Auth
+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 NoAuth(Auth):
+    """
+    Auth configuration while using no auth mode
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NoAuth object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.NoAuth.auth_type` attribute
+        of this class is ``NO_AUTH`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param auth_type:
+            The value to assign to the auth_type property of this NoAuth.
+            Allowed values for this property are: "NO_AUTH", "BEARER_TOKEN", "OAUTH", "OCI_RESOURCE_PRINCIPAL"
+        :type auth_type: str
+
+        """
+        self.swagger_types = {
+            'auth_type': 'str'
+        }
+
+        self.attribute_map = {
+            'auth_type': 'authType'
+        }
+
+        self._auth_type = None
+        self._auth_type = 'NO_AUTH'
+
+    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

aidp_python_client/aidataplatform_dp/models/node_input.py

@@ -0,0 +1,246 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+
+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 NodeInput(object):
+    """
+    An input slot for a node, including type and requirements.
+    """
+
+    #: A constant which can be used with the port_position property of a NodeInput.
+    #: This constant has a value of "TOP"
+    PORT_POSITION_TOP = "TOP"
+
+    #: A constant which can be used with the port_position property of a NodeInput.
+    #: This constant has a value of "BOTTOM"
+    PORT_POSITION_BOTTOM = "BOTTOM"
+
+    #: A constant which can be used with the port_position property of a NodeInput.
+    #: This constant has a value of "RIGHT"
+    PORT_POSITION_RIGHT = "RIGHT"
+
+    #: A constant which can be used with the port_position property of a NodeInput.
+    #: This constant has a value of "LEFT"
+    PORT_POSITION_LEFT = "LEFT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NodeInput 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 NodeInput.
+        :type name: str
+
+        :param type:
+            The value to assign to the type property of this NodeInput.
+        :type type: oci.aidataplatform_dp.models.NodeIo
+
+        :param port_position:
+            The value to assign to the port_position property of this NodeInput.
+            Allowed values for this property are: "TOP", "BOTTOM", "RIGHT", "LEFT"
+        :type port_position: str
+
+        :param description:
+            The value to assign to the description property of this NodeInput.
+        :type description: str
+
+        :param is_required:
+            The value to assign to the is_required property of this NodeInput.
+        :type is_required: bool
+
+        :param is_single_connection:
+            The value to assign to the is_single_connection property of this NodeInput.
+        :type is_single_connection: bool
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'type': 'NodeIo',
+            'port_position': 'str',
+            'description': 'str',
+            'is_required': 'bool',
+            'is_single_connection': 'bool'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'type': 'type',
+            'port_position': 'portPosition',
+            'description': 'description',
+            'is_required': 'isRequired',
+            'is_single_connection': 'isSingleConnection'
+        }
+
+        self._name = None
+        self._type = None
+        self._port_position = None
+        self._description = None
+        self._is_required = None
+        self._is_single_connection = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this NodeInput.
+        Unique name for the input slot.
+
+
+        :return: The name of this NodeInput.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this NodeInput.
+        Unique name for the input slot.
+
+
+        :param name: The name of this NodeInput.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this NodeInput.
+
+        :return: The type of this NodeInput.
+        :rtype: oci.aidataplatform_dp.models.NodeIo
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this NodeInput.
+
+        :param type: The type of this NodeInput.
+        :type: oci.aidataplatform_dp.models.NodeIo
+        """
+        self._type = type
+
+    @property
+    def port_position(self):
+        """
+        Gets the port_position of this NodeInput.
+        UI position of the input port on the node.
+
+        Allowed values for this property are: "TOP", "BOTTOM", "RIGHT", "LEFT"
+
+
+        :return: The port_position of this NodeInput.
+        :rtype: str
+        """
+        return self._port_position
+
+    @port_position.setter
+    def port_position(self, port_position):
+        """
+        Sets the port_position of this NodeInput.
+        UI position of the input port on the node.
+
+
+        :param port_position: The port_position of this NodeInput.
+        :type: str
+        """
+        allowed_values = ["TOP", "BOTTOM", "RIGHT", "LEFT"]
+        if not value_allowed_none_or_none_sentinel(port_position, allowed_values):
+            raise ValueError(
+                "Invalid value for `port_position`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._port_position = port_position
+
+    @property
+    def description(self):
+        """
+        Gets the description of this NodeInput.
+        Documentation or tooltip shown in the UI.
+
+
+        :return: The description of this NodeInput.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this NodeInput.
+        Documentation or tooltip shown in the UI.
+
+
+        :param description: The description of this NodeInput.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def is_required(self):
+        """
+        **[Required]** Gets the is_required of this NodeInput.
+        True if this input is mandatory.
+
+
+        :return: The is_required of this NodeInput.
+        :rtype: bool
+        """
+        return self._is_required
+
+    @is_required.setter
+    def is_required(self, is_required):
+        """
+        Sets the is_required of this NodeInput.
+        True if this input is mandatory.
+
+
+        :param is_required: The is_required of this NodeInput.
+        :type: bool
+        """
+        self._is_required = is_required
+
+    @property
+    def is_single_connection(self):
+        """
+        Gets the is_single_connection of this NodeInput.
+        True if only one connection is allowed; false allows multiple.
+
+
+        :return: The is_single_connection of this NodeInput.
+        :rtype: bool
+        """
+        return self._is_single_connection
+
+    @is_single_connection.setter
+    def is_single_connection(self, is_single_connection):
+        """
+        Sets the is_single_connection of this NodeInput.
+        True if only one connection is allowed; false allows multiple.
+
+
+        :param is_single_connection: The is_single_connection of this NodeInput.
+        :type: bool
+        """
+        self._is_single_connection = is_single_connection
+
+    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