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

aidp_python_client/aidataplatform_dp/models/create_knowledge_base_job_details.py

@@ -0,0 +1,290 @@
+# 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 CreateKnowledgeBaseJobDetails(object):
+    """
+    Request body for creating a new job definition for a KnowledgeBase.
+    """
+
+    #: A constant which can be used with the type property of a CreateKnowledgeBaseJobDetails.
+    #: This constant has a value of "SCHEDULED"
+    TYPE_SCHEDULED = "SCHEDULED"
+
+    #: A constant which can be used with the type property of a CreateKnowledgeBaseJobDetails.
+    #: This constant has a value of "ON_DEMAND"
+    TYPE_ON_DEMAND = "ON_DEMAND"
+
+    #: A constant which can be used with the goal property of a CreateKnowledgeBaseJobDetails.
+    #: This constant has a value of "ADD_REFRESH_SOURCE"
+    GOAL_ADD_REFRESH_SOURCE = "ADD_REFRESH_SOURCE"
+
+    #: A constant which can be used with the goal property of a CreateKnowledgeBaseJobDetails.
+    #: This constant has a value of "DELETE_SOURCE"
+    GOAL_DELETE_SOURCE = "DELETE_SOURCE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateKnowledgeBaseJobDetails 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 CreateKnowledgeBaseJobDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this CreateKnowledgeBaseJobDetails.
+        :type description: str
+
+        :param type:
+            The value to assign to the type property of this CreateKnowledgeBaseJobDetails.
+            Allowed values for this property are: "SCHEDULED", "ON_DEMAND"
+        :type type: str
+
+        :param goal:
+            The value to assign to the goal property of this CreateKnowledgeBaseJobDetails.
+            Allowed values for this property are: "ADD_REFRESH_SOURCE", "DELETE_SOURCE"
+        :type goal: str
+
+        :param sources:
+            The value to assign to the sources property of this CreateKnowledgeBaseJobDetails.
+        :type sources: str
+
+        :param source_key:
+            The value to assign to the source_key property of this CreateKnowledgeBaseJobDetails.
+        :type source_key: str
+
+        :param schedule:
+            The value to assign to the schedule property of this CreateKnowledgeBaseJobDetails.
+        :type schedule: str
+
+        """
+        self.swagger_types = {
+            'display_name': 'str',
+            'description': 'str',
+            'type': 'str',
+            'goal': 'str',
+            'sources': 'str',
+            'source_key': 'str',
+            'schedule': 'str'
+        }
+
+        self.attribute_map = {
+            'display_name': 'displayName',
+            'description': 'description',
+            'type': 'type',
+            'goal': 'goal',
+            'sources': 'sources',
+            'source_key': 'sourceKey',
+            'schedule': 'schedule'
+        }
+
+        self._display_name = None
+        self._description = None
+        self._type = None
+        self._goal = None
+        self._sources = None
+        self._source_key = None
+        self._schedule = None
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this CreateKnowledgeBaseJobDetails.
+        Name of KnowledgeBase Job Definition
+
+
+        :return: The display_name of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this CreateKnowledgeBaseJobDetails.
+        Name of KnowledgeBase Job Definition
+
+
+        :param display_name: The display_name of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CreateKnowledgeBaseJobDetails.
+        The description of KnowledgeBase Job
+
+
+        :return: The description of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateKnowledgeBaseJobDetails.
+        The description of KnowledgeBase Job
+
+
+        :param description: The description of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this CreateKnowledgeBaseJobDetails.
+        type of KB Job
+
+        Allowed values for this property are: "SCHEDULED", "ON_DEMAND"
+
+
+        :return: The type of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this CreateKnowledgeBaseJobDetails.
+        type of KB Job
+
+
+        :param type: The type of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        allowed_values = ["SCHEDULED", "ON_DEMAND"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            raise ValueError(
+                "Invalid value for `type`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._type = type
+
+    @property
+    def goal(self):
+        """
+        Gets the goal of this CreateKnowledgeBaseJobDetails.
+        type of KB Job Goal, if missing it is considered that job aims to add/refresh the sources
+
+        Allowed values for this property are: "ADD_REFRESH_SOURCE", "DELETE_SOURCE"
+
+
+        :return: The goal of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._goal
+
+    @goal.setter
+    def goal(self, goal):
+        """
+        Sets the goal of this CreateKnowledgeBaseJobDetails.
+        type of KB Job Goal, if missing it is considered that job aims to add/refresh the sources
+
+
+        :param goal: The goal of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        allowed_values = ["ADD_REFRESH_SOURCE", "DELETE_SOURCE"]
+        if not value_allowed_none_or_none_sentinel(goal, allowed_values):
+            raise ValueError(
+                "Invalid value for `goal`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._goal = goal
+
+    @property
+    def sources(self):
+        """
+        Gets the sources of this CreateKnowledgeBaseJobDetails.
+        Name of the source, \"*\" should be provided to create a DEFAULT JOB and sourceKey can be left null/empty for DEFAULT Job
+
+
+        :return: The sources of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._sources
+
+    @sources.setter
+    def sources(self, sources):
+        """
+        Sets the sources of this CreateKnowledgeBaseJobDetails.
+        Name of the source, \"*\" should be provided to create a DEFAULT JOB and sourceKey can be left null/empty for DEFAULT Job
+
+
+        :param sources: The sources of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        self._sources = sources
+
+    @property
+    def source_key(self):
+        """
+        Gets the source_key of this CreateKnowledgeBaseJobDetails.
+        Id of the source, should be provided for all jobs except DEFAULT JOB (which is supposed to run at all sources of KB)
+
+
+        :return: The source_key of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._source_key
+
+    @source_key.setter
+    def source_key(self, source_key):
+        """
+        Sets the source_key of this CreateKnowledgeBaseJobDetails.
+        Id of the source, should be provided for all jobs except DEFAULT JOB (which is supposed to run at all sources of KB)
+
+
+        :param source_key: The source_key of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        self._source_key = source_key
+
+    @property
+    def schedule(self):
+        """
+        Gets the schedule of this CreateKnowledgeBaseJobDetails.
+        If the job type is SCHEDULED, this field is used to provide schedule information in cron style. For example, \"0 0 * * *\" means 12:00 AM daily
+
+
+        :return: The schedule of this CreateKnowledgeBaseJobDetails.
+        :rtype: str
+        """
+        return self._schedule
+
+    @schedule.setter
+    def schedule(self, schedule):
+        """
+        Sets the schedule of this CreateKnowledgeBaseJobDetails.
+        If the job type is SCHEDULED, this field is used to provide schedule information in cron style. For example, \"0 0 * * *\" means 12:00 AM daily
+
+
+        :param schedule: The schedule of this CreateKnowledgeBaseJobDetails.
+        :type: str
+        """
+        self._schedule = schedule
+
+    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/create_knowledge_base_job_run_details.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 CreateKnowledgeBaseJobRunDetails(object):
+    """
+    Request body for creating a new job run for a job in a KnowledgeBase.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateKnowledgeBaseJobRunDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param description:
+            The value to assign to the description property of this CreateKnowledgeBaseJobRunDetails.
+        :type description: str
+
+        """
+        self.swagger_types = {
+            'description': 'str'
+        }
+
+        self.attribute_map = {
+            'description': 'description'
+        }
+
+        self._description = None
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CreateKnowledgeBaseJobRunDetails.
+        The description of KB Job
+
+
+        :return: The description of this CreateKnowledgeBaseJobRunDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateKnowledgeBaseJobRunDetails.
+        The description of KB Job
+
+
+        :param description: The description of this CreateKnowledgeBaseJobRunDetails.
+        :type: str
+        """
+        self._description = description
+
+    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/create_master_catalog_details.py

@@ -0,0 +1,101 @@
+# 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 CreateMasterCatalogDetails(object):
+    """
+    The data to create a Master Catalog.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateMasterCatalogDetails 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 CreateMasterCatalogDetails.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this CreateMasterCatalogDetails.
+        :type description: str
+
+        """
+        self.swagger_types = {
+            'display_name': 'str',
+            'description': 'str'
+        }
+
+        self.attribute_map = {
+            'display_name': 'displayName',
+            'description': 'description'
+        }
+
+        self._display_name = None
+        self._description = None
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this CreateMasterCatalogDetails.
+        A user-friendly name. Has to be unique and it's changeable.
+
+
+        :return: The display_name of this CreateMasterCatalogDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this CreateMasterCatalogDetails.
+        A user-friendly name. Has to be unique and it's changeable.
+
+
+        :param display_name: The display_name of this CreateMasterCatalogDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this CreateMasterCatalogDetails.
+        Short description of the catalog
+
+
+        :return: The description of this CreateMasterCatalogDetails.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this CreateMasterCatalogDetails.
+        Short description of the catalog
+
+
+        :param description: The description of this CreateMasterCatalogDetails.
+        :type: str
+        """
+        self._description = description
+
+    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/create_mcp_tool_node_details.py

@@ -0,0 +1,208 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+from .create_agent_flow_node_details import CreateAgentFlowNodeDetails
+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 CreateMcpToolNodeDetails(CreateAgentFlowNodeDetails):
+    """
+    Details to create a MCP Tool Node in an Agent Flow
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateMcpToolNodeDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.aidataplatform_dp.models.CreateMcpToolNodeDetails.type` attribute
+        of this class is ``MCP_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 CreateMcpToolNodeDetails.
+            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 CreateMcpToolNodeDetails.
+        :type node_type: str
+
+        :param name:
+            The value to assign to the name property of this CreateMcpToolNodeDetails.
+        :type name: str
+
+        :param description:
+            The value to assign to the description property of this CreateMcpToolNodeDetails.
+        :type description: str
+
+        :param position_x:
+            The value to assign to the position_x property of this CreateMcpToolNodeDetails.
+        :type position_x: float
+
+        :param position_y:
+            The value to assign to the position_y property of this CreateMcpToolNodeDetails.
+        :type position_y: float
+
+        :param is_expanded:
+            The value to assign to the is_expanded property of this CreateMcpToolNodeDetails.
+        :type is_expanded: bool
+
+        :param parent_node_id:
+            The value to assign to the parent_node_id property of this CreateMcpToolNodeDetails.
+        :type parent_node_id: str
+
+        :param src_node_id:
+            The value to assign to the src_node_id property of this CreateMcpToolNodeDetails.
+        :type src_node_id: str
+
+        :param configuration:
+            The value to assign to the configuration property of this CreateMcpToolNodeDetails.
+        :type configuration: dict(str, object)
+
+        :param node_type_id:
+            The value to assign to the node_type_id property of this CreateMcpToolNodeDetails.
+        :type node_type_id: str
+
+        :param tool_key:
+            The value to assign to the tool_key property of this CreateMcpToolNodeDetails.
+        :type tool_key: str
+
+        :param input_schema:
+            The value to assign to the input_schema property of this CreateMcpToolNodeDetails.
+        :type input_schema: dict(str, object)
+
+        :param tool_config:
+            The value to assign to the tool_config property of this CreateMcpToolNodeDetails.
+        :type tool_config: oci.aidataplatform_dp.models.McpToolConfiguration
+
+        """
+        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',
+            'src_node_id': 'str',
+            'configuration': 'dict(str, object)',
+            'node_type_id': 'str',
+            'tool_key': 'str',
+            'input_schema': 'dict(str, object)',
+            'tool_config': 'McpToolConfiguration'
+        }
+
+        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',
+            'src_node_id': 'srcNodeId',
+            'configuration': 'configuration',
+            'node_type_id': 'nodeTypeId',
+            'tool_key': 'toolKey',
+            'input_schema': 'inputSchema',
+            'tool_config': 'toolConfig'
+        }
+
+        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._src_node_id = None
+        self._configuration = None
+        self._node_type_id = None
+        self._tool_key = None
+        self._input_schema = None
+        self._tool_config = None
+        self._type = 'MCP_TOOL'
+
+    @property
+    def tool_key(self):
+        """
+        Gets the tool_key of this CreateMcpToolNodeDetails.
+        The unique identifier (key) of the saved AI tool
+
+
+        :return: The tool_key of this CreateMcpToolNodeDetails.
+        :rtype: str
+        """
+        return self._tool_key
+
+    @tool_key.setter
+    def tool_key(self, tool_key):
+        """
+        Sets the tool_key of this CreateMcpToolNodeDetails.
+        The unique identifier (key) of the saved AI tool
+
+
+        :param tool_key: The tool_key of this CreateMcpToolNodeDetails.
+        :type: str
+        """
+        self._tool_key = tool_key
+
+    @property
+    def input_schema(self):
+        """
+        Gets the input_schema of this CreateMcpToolNodeDetails.
+        The list of properties in the inputSchema, along with the default value and description of each property
+
+
+        :return: The input_schema of this CreateMcpToolNodeDetails.
+        :rtype: dict(str, object)
+        """
+        return self._input_schema
+
+    @input_schema.setter
+    def input_schema(self, input_schema):
+        """
+        Sets the input_schema of this CreateMcpToolNodeDetails.
+        The list of properties in the inputSchema, along with the default value and description of each property
+
+
+        :param input_schema: The input_schema of this CreateMcpToolNodeDetails.
+        :type: dict(str, object)
+        """
+        self._input_schema = input_schema
+
+    @property
+    def tool_config(self):
+        """
+        Gets the tool_config of this CreateMcpToolNodeDetails.
+
+        :return: The tool_config of this CreateMcpToolNodeDetails.
+        :rtype: oci.aidataplatform_dp.models.McpToolConfiguration
+        """
+        return self._tool_config
+
+    @tool_config.setter
+    def tool_config(self, tool_config):
+        """
+        Sets the tool_config of this CreateMcpToolNodeDetails.
+
+        :param tool_config: The tool_config of this CreateMcpToolNodeDetails.
+        :type: oci.aidataplatform_dp.models.McpToolConfiguration
+        """
+        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