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

aidp_python_client/aidataplatform_dp/models/rag_tool.py

@@ -0,0 +1,180 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .tool import Tool
+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 RagTool(Tool):
+    """
+    Derived model for RAG Tool
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RagTool object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.RagTool.tool_type` attribute
+        of this class is ``RAG`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param key:
+            The value to assign to the key property of this RagTool.
+        :type key: str
+
+        :param display_name:
+            The value to assign to the display_name property of this RagTool.
+        :type display_name: str
+
+        :param workspace_key:
+            The value to assign to the workspace_key property of this RagTool.
+        :type workspace_key: str
+
+        :param description:
+            The value to assign to the description property of this RagTool.
+        :type description: str
+
+        :param tool_type:
+            The value to assign to the tool_type property of this RagTool.
+            Allowed values for this property are: "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP"
+        :type tool_type: str
+
+        :param position_x:
+            The value to assign to the position_x property of this RagTool.
+        :type position_x: float
+
+        :param position_y:
+            The value to assign to the position_y property of this RagTool.
+        :type position_y: float
+
+        :param properties:
+            The value to assign to the properties property of this RagTool.
+        :type properties: dict(str, object)
+
+        :param time_created:
+            The value to assign to the time_created property of this RagTool.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this RagTool.
+        :type time_updated: datetime
+
+        :param created_by:
+            The value to assign to the created_by property of this RagTool.
+        :type created_by: str
+
+        :param updated_by:
+            The value to assign to the updated_by property of this RagTool.
+        :type updated_by: str
+
+        :param input_schema:
+            The value to assign to the input_schema property of this RagTool.
+        :type input_schema: oci.aidataplatform_dp.models.RagToolInputSchema
+
+        :param tool_config:
+            The value to assign to the tool_config property of this RagTool.
+        :type tool_config: oci.aidataplatform_dp.models.RagToolConfiguration
+
+        """
+        self.swagger_types = {
+            'key': 'str',
+            'display_name': 'str',
+            'workspace_key': 'str',
+            'description': 'str',
+            'tool_type': 'str',
+            'position_x': 'float',
+            'position_y': 'float',
+            'properties': 'dict(str, object)',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'created_by': 'str',
+            'updated_by': 'str',
+            'input_schema': 'RagToolInputSchema',
+            'tool_config': 'RagToolConfiguration'
+        }
+
+        self.attribute_map = {
+            'key': 'key',
+            'display_name': 'displayName',
+            'workspace_key': 'workspaceKey',
+            'description': 'description',
+            'tool_type': 'toolType',
+            'position_x': 'positionX',
+            'position_y': 'positionY',
+            'properties': 'properties',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'created_by': 'createdBy',
+            'updated_by': 'updatedBy',
+            'input_schema': 'inputSchema',
+            'tool_config': 'toolConfig'
+        }
+
+        self._key = None
+        self._display_name = None
+        self._workspace_key = None
+        self._description = None
+        self._tool_type = None
+        self._position_x = None
+        self._position_y = None
+        self._properties = None
+        self._time_created = None
+        self._time_updated = None
+        self._created_by = None
+        self._updated_by = None
+        self._input_schema = None
+        self._tool_config = None
+        self._tool_type = 'RAG'
+
+    @property
+    def input_schema(self):
+        """
+        Gets the input_schema of this RagTool.
+
+        :return: The input_schema of this RagTool.
+        :rtype: oci.aidataplatform_dp.models.RagToolInputSchema
+        """
+        return self._input_schema
+
+    @input_schema.setter
+    def input_schema(self, input_schema):
+        """
+        Sets the input_schema of this RagTool.
+
+        :param input_schema: The input_schema of this RagTool.
+        :type: oci.aidataplatform_dp.models.RagToolInputSchema
+        """
+        self._input_schema = input_schema
+
+    @property
+    def tool_config(self):
+        """
+        Gets the tool_config of this RagTool.
+
+        :return: The tool_config of this RagTool.
+        :rtype: oci.aidataplatform_dp.models.RagToolConfiguration
+        """
+        return self._tool_config
+
+    @tool_config.setter
+    def tool_config(self, tool_config):
+        """
+        Sets the tool_config of this RagTool.
+
+        :param tool_config: The tool_config of this RagTool.
+        :type: oci.aidataplatform_dp.models.RagToolConfiguration
+        """
+        self._tool_config = tool_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

aidp_python_client/aidataplatform_dp/models/rag_tool_configuration.py

@@ -0,0 +1,221 @@
+# 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 RagToolConfiguration(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 RagToolConfiguration 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 RagToolConfiguration.
+        :type catalog_key: str
+
+        :param schema_key:
+            The value to assign to the schema_key property of this RagToolConfiguration.
+        :type schema_key: str
+
+        :param knowledge_base:
+            The value to assign to the knowledge_base property of this RagToolConfiguration.
+        :type knowledge_base: str
+
+        :param llm:
+            The value to assign to the llm property of this RagToolConfiguration.
+        :type llm: oci.aidataplatform_dp.models.LlmConfig
+
+        :param model_settings:
+            The value to assign to the model_settings property of this RagToolConfiguration.
+        :type model_settings: dict(str, object)
+
+        :param top_k:
+            The value to assign to the top_k property of this RagToolConfiguration.
+        :type top_k: int
+
+        """
+        self.swagger_types = {
+            'catalog_key': 'str',
+            'schema_key': 'str',
+            'knowledge_base': 'str',
+            'llm': 'LlmConfig',
+            'model_settings': 'dict(str, object)',
+            'top_k': 'int'
+        }
+
+        self.attribute_map = {
+            'catalog_key': 'catalogKey',
+            'schema_key': 'schemaKey',
+            'knowledge_base': 'knowledgeBase',
+            'llm': 'llm',
+            'model_settings': 'modelSettings',
+            'top_k': 'topK'
+        }
+
+        self._catalog_key = None
+        self._schema_key = None
+        self._knowledge_base = None
+        self._llm = None
+        self._model_settings = None
+        self._top_k = None
+
+    @property
+    def catalog_key(self):
+        """
+        Gets the catalog_key of this RagToolConfiguration.
+        The Catalog to use for KB tool execution
+
+
+        :return: The catalog_key of this RagToolConfiguration.
+        :rtype: str
+        """
+        return self._catalog_key
+
+    @catalog_key.setter
+    def catalog_key(self, catalog_key):
+        """
+        Sets the catalog_key of this RagToolConfiguration.
+        The Catalog to use for KB tool execution
+
+
+        :param catalog_key: The catalog_key of this RagToolConfiguration.
+        :type: str
+        """
+        self._catalog_key = catalog_key
+
+    @property
+    def schema_key(self):
+        """
+        Gets the schema_key of this RagToolConfiguration.
+        The Schema to use for KB tool execution
+
+
+        :return: The schema_key of this RagToolConfiguration.
+        :rtype: str
+        """
+        return self._schema_key
+
+    @schema_key.setter
+    def schema_key(self, schema_key):
+        """
+        Sets the schema_key of this RagToolConfiguration.
+        The Schema to use for KB tool execution
+
+
+        :param schema_key: The schema_key of this RagToolConfiguration.
+        :type: str
+        """
+        self._schema_key = schema_key
+
+    @property
+    def knowledge_base(self):
+        """
+        Gets the knowledge_base of this RagToolConfiguration.
+        The name of the Knowledge Base to use for RAG query
+
+
+        :return: The knowledge_base of this RagToolConfiguration.
+        :rtype: str
+        """
+        return self._knowledge_base
+
+    @knowledge_base.setter
+    def knowledge_base(self, knowledge_base):
+        """
+        Sets the knowledge_base of this RagToolConfiguration.
+        The name of the Knowledge Base to use for RAG query
+
+
+        :param knowledge_base: The knowledge_base of this RagToolConfiguration.
+        :type: str
+        """
+        self._knowledge_base = knowledge_base
+
+    @property
+    def llm(self):
+        """
+        Gets the llm of this RagToolConfiguration.
+
+        :return: The llm of this RagToolConfiguration.
+        :rtype: oci.aidataplatform_dp.models.LlmConfig
+        """
+        return self._llm
+
+    @llm.setter
+    def llm(self, llm):
+        """
+        Sets the llm of this RagToolConfiguration.
+
+        :param llm: The llm of this RagToolConfiguration.
+        :type: oci.aidataplatform_dp.models.LlmConfig
+        """
+        self._llm = llm
+
+    @property
+    def model_settings(self):
+        """
+        Gets the model_settings of this RagToolConfiguration.
+        Model specific inference parameters such as temperature, top-k, max length, response format, etc.
+
+
+        :return: The model_settings of this RagToolConfiguration.
+        :rtype: dict(str, object)
+        """
+        return self._model_settings
+
+    @model_settings.setter
+    def model_settings(self, model_settings):
+        """
+        Sets the model_settings of this RagToolConfiguration.
+        Model specific inference parameters such as temperature, top-k, max length, response format, etc.
+
+
+        :param model_settings: The model_settings of this RagToolConfiguration.
+        :type: dict(str, object)
+        """
+        self._model_settings = model_settings
+
+    @property
+    def top_k(self):
+        """
+        Gets the top_k of this RagToolConfiguration.
+        Number of top chunks to retrieve from the KB
+
+
+        :return: The top_k of this RagToolConfiguration.
+        :rtype: int
+        """
+        return self._top_k
+
+    @top_k.setter
+    def top_k(self, top_k):
+        """
+        Sets the top_k of this RagToolConfiguration.
+        Number of top chunks to retrieve from the KB
+
+
+        :param top_k: The top_k of this RagToolConfiguration.
+        :type: int
+        """
+        self._top_k = top_k
+
+    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/rag_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 RagToolInputSchema(object):
+    """
+    The input schema definition of a RAG Tool
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RagToolInputSchema 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 RagToolInputSchema.
+        :type query: str
+
+        """
+        self.swagger_types = {
+            'query': 'str'
+        }
+
+        self.attribute_map = {
+            'query': 'query'
+        }
+
+        self._query = None
+
+    @property
+    def query(self):
+        """
+        Gets the query of this RagToolInputSchema.
+        The user question to answer using relevant documents
+
+
+        :return: The query of this RagToolInputSchema.
+        :rtype: str
+        """
+        return self._query
+
+    @query.setter
+    def query(self, query):
+        """
+        Sets the query of this RagToolInputSchema.
+        The user question to answer using relevant documents
+
+
+        :param query: The query of this RagToolInputSchema.
+        :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/rag_tool_node.py

@@ -0,0 +1,181 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .agent_flow_node import AgentFlowNode
+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 RagToolNode(AgentFlowNode):
+    """
+    A Tool Node in an Agent Flow
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RagToolNode object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.RagToolNode.type` attribute
+        of this class is ``RAG_TOOL`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param type:
+            The value to assign to the type property of this RagToolNode.
+            Allowed values for this property are: "START_NODE", "GUARDRAILS", "AGENT", "SUPERVISOR_AGENT", "NESTED_AGENT_FLOW", "EXTERNAL_AGENT", "HUMAN_IN_THE_LOOP", "SQL_TOOL", "PROMPT_TOOL", "RAG_TOOL", "MCP_TOOL", "HTTP_TOOL", "CUSTOM_TOOL"
+        :type type: str
+
+        :param node_type:
+            The value to assign to the node_type property of this RagToolNode.
+        :type node_type: str
+
+        :param name:
+            The value to assign to the name property of this RagToolNode.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this RagToolNode.
+        :type description: str
+
+        :param position_x:
+            The value to assign to the position_x property of this RagToolNode.
+        :type position_x: float
+
+        :param position_y:
+            The value to assign to the position_y property of this RagToolNode.
+        :type position_y: float
+
+        :param is_expanded:
+            The value to assign to the is_expanded property of this RagToolNode.
+        :type is_expanded: bool
+
+        :param parent_node_id:
+            The value to assign to the parent_node_id property of this RagToolNode.
+        :type parent_node_id: str
+
+        :param configuration:
+            The value to assign to the configuration property of this RagToolNode.
+        :type configuration: dict(str, object)
+
+        :param node_type_id:
+            The value to assign to the node_type_id property of this RagToolNode.
+        :type node_type_id: str
+
+        :param key:
+            The value to assign to the key property of this RagToolNode.
+        :type key: str
+
+        :param time_created:
+            The value to assign to the time_created property of this RagToolNode.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this RagToolNode.
+        :type time_updated: datetime
+
+        :param inputs:
+            The value to assign to the inputs property of this RagToolNode.
+        :type inputs: list[oci.aidataplatform_dp.models.NodeInput]
+
+        :param outputs:
+            The value to assign to the outputs property of this RagToolNode.
+        :type outputs: list[oci.aidataplatform_dp.models.NodeOutput]
+
+        :param validation_errors:
+            The value to assign to the validation_errors property of this RagToolNode.
+        :type validation_errors: list[oci.aidataplatform_dp.models.ValidationError]
+
+        :param input_schema:
+            The value to assign to the input_schema property of this RagToolNode.
+        :type input_schema: oci.aidataplatform_dp.models.RagToolInputSchema
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'node_type': 'str',
+            'name': 'str',
+            'description': 'str',
+            'position_x': 'float',
+            'position_y': 'float',
+            'is_expanded': 'bool',
+            'parent_node_id': 'str',
+            'configuration': 'dict(str, object)',
+            'node_type_id': 'str',
+            'key': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'inputs': 'list[NodeInput]',
+            'outputs': 'list[NodeOutput]',
+            'validation_errors': 'list[ValidationError]',
+            'input_schema': 'RagToolInputSchema'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'node_type': 'nodeType',
+            'name': 'name',
+            'description': 'description',
+            'position_x': 'positionX',
+            'position_y': 'positionY',
+            'is_expanded': 'isExpanded',
+            'parent_node_id': 'parentNodeId',
+            'configuration': 'configuration',
+            'node_type_id': 'nodeTypeId',
+            'key': 'key',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'inputs': 'inputs',
+            'outputs': 'outputs',
+            'validation_errors': 'validationErrors',
+            'input_schema': 'inputSchema'
+        }
+
+        self._type = None
+        self._node_type = None
+        self._name = None
+        self._description = None
+        self._position_x = None
+        self._position_y = None
+        self._is_expanded = None
+        self._parent_node_id = None
+        self._configuration = None
+        self._node_type_id = None
+        self._key = None
+        self._time_created = None
+        self._time_updated = None
+        self._inputs = None
+        self._outputs = None
+        self._validation_errors = None
+        self._input_schema = None
+        self._type = 'RAG_TOOL'
+
+    @property
+    def input_schema(self):
+        """
+        Gets the input_schema of this RagToolNode.
+
+        :return: The input_schema of this RagToolNode.
+        :rtype: oci.aidataplatform_dp.models.RagToolInputSchema
+        """
+        return self._input_schema
+
+    @input_schema.setter
+    def input_schema(self, input_schema):
+        """
+        Sets the input_schema of this RagToolNode.
+
+        :param input_schema: The input_schema of this RagToolNode.
+        :type: oci.aidataplatform_dp.models.RagToolInputSchema
+        """
+        self._input_schema = input_schema
+
+    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