oci 2.134.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

oci/generative_ai_agent/models/__init__.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 __future__ import absolute_import
+
+from .agent import Agent
+from .agent_collection import AgentCollection
+from .agent_endpoint import AgentEndpoint
+from .agent_endpoint_collection import AgentEndpointCollection
+from .agent_endpoint_summary import AgentEndpointSummary
+from .agent_summary import AgentSummary
+from .basic_auth_secret import BasicAuthSecret
+from .change_agent_compartment_details import ChangeAgentCompartmentDetails
+from .change_agent_endpoint_compartment_details import ChangeAgentEndpointCompartmentDetails
+from .change_knowledge_base_compartment_details import ChangeKnowledgeBaseCompartmentDetails
+from .content_moderation_config import ContentModerationConfig
+from .create_agent_details import CreateAgentDetails
+from .create_agent_endpoint_details import CreateAgentEndpointDetails
+from .create_data_ingestion_job_details import CreateDataIngestionJobDetails
+from .create_data_source_details import CreateDataSourceDetails
+from .create_knowledge_base_details import CreateKnowledgeBaseDetails
+from .data_ingestion_job import DataIngestionJob
+from .data_ingestion_job_collection import DataIngestionJobCollection
+from .data_ingestion_job_statistics import DataIngestionJobStatistics
+from .data_ingestion_job_summary import DataIngestionJobSummary
+from .data_source import DataSource
+from .data_source_collection import DataSourceCollection
+from .data_source_config import DataSourceConfig
+from .data_source_summary import DataSourceSummary
+from .database_connection import DatabaseConnection
+from .database_function import DatabaseFunction
+from .database_tool_connection import DatabaseToolConnection
+from .default_index_config import DefaultIndexConfig
+from .idcs_secret import IdcsSecret
+from .index import Index
+from .index_config import IndexConfig
+from .index_schema import IndexSchema
+from .knowledge_base import KnowledgeBase
+from .knowledge_base_collection import KnowledgeBaseCollection
+from .knowledge_base_summary import KnowledgeBaseSummary
+from .object_storage_prefix import ObjectStoragePrefix
+from .oci_database_config import OciDatabaseConfig
+from .oci_object_storage_data_source_config import OciObjectStorageDataSourceConfig
+from .oci_open_search_index_config import OciOpenSearchIndexConfig
+from .secret_detail import SecretDetail
+from .session_config import SessionConfig
+from .update_agent_details import UpdateAgentDetails
+from .update_agent_endpoint_details import UpdateAgentEndpointDetails
+from .update_data_source_details import UpdateDataSourceDetails
+from .update_knowledge_base_details import UpdateKnowledgeBaseDetails
+from .work_request import WorkRequest
+from .work_request_error import WorkRequestError
+from .work_request_error_collection import WorkRequestErrorCollection
+from .work_request_log_entry import WorkRequestLogEntry
+from .work_request_log_entry_collection import WorkRequestLogEntryCollection
+from .work_request_resource import WorkRequestResource
+from .work_request_summary import WorkRequestSummary
+from .work_request_summary_collection import WorkRequestSummaryCollection
+
+# Maps type names to classes for generative_ai_agent services.
+generative_ai_agent_type_mapping = {
+    "Agent": Agent,
+    "AgentCollection": AgentCollection,
+    "AgentEndpoint": AgentEndpoint,
+    "AgentEndpointCollection": AgentEndpointCollection,
+    "AgentEndpointSummary": AgentEndpointSummary,
+    "AgentSummary": AgentSummary,
+    "BasicAuthSecret": BasicAuthSecret,
+    "ChangeAgentCompartmentDetails": ChangeAgentCompartmentDetails,
+    "ChangeAgentEndpointCompartmentDetails": ChangeAgentEndpointCompartmentDetails,
+    "ChangeKnowledgeBaseCompartmentDetails": ChangeKnowledgeBaseCompartmentDetails,
+    "ContentModerationConfig": ContentModerationConfig,
+    "CreateAgentDetails": CreateAgentDetails,
+    "CreateAgentEndpointDetails": CreateAgentEndpointDetails,
+    "CreateDataIngestionJobDetails": CreateDataIngestionJobDetails,
+    "CreateDataSourceDetails": CreateDataSourceDetails,
+    "CreateKnowledgeBaseDetails": CreateKnowledgeBaseDetails,
+    "DataIngestionJob": DataIngestionJob,
+    "DataIngestionJobCollection": DataIngestionJobCollection,
+    "DataIngestionJobStatistics": DataIngestionJobStatistics,
+    "DataIngestionJobSummary": DataIngestionJobSummary,
+    "DataSource": DataSource,
+    "DataSourceCollection": DataSourceCollection,
+    "DataSourceConfig": DataSourceConfig,
+    "DataSourceSummary": DataSourceSummary,
+    "DatabaseConnection": DatabaseConnection,
+    "DatabaseFunction": DatabaseFunction,
+    "DatabaseToolConnection": DatabaseToolConnection,
+    "DefaultIndexConfig": DefaultIndexConfig,
+    "IdcsSecret": IdcsSecret,
+    "Index": Index,
+    "IndexConfig": IndexConfig,
+    "IndexSchema": IndexSchema,
+    "KnowledgeBase": KnowledgeBase,
+    "KnowledgeBaseCollection": KnowledgeBaseCollection,
+    "KnowledgeBaseSummary": KnowledgeBaseSummary,
+    "ObjectStoragePrefix": ObjectStoragePrefix,
+    "OciDatabaseConfig": OciDatabaseConfig,
+    "OciObjectStorageDataSourceConfig": OciObjectStorageDataSourceConfig,
+    "OciOpenSearchIndexConfig": OciOpenSearchIndexConfig,
+    "SecretDetail": SecretDetail,
+    "SessionConfig": SessionConfig,
+    "UpdateAgentDetails": UpdateAgentDetails,
+    "UpdateAgentEndpointDetails": UpdateAgentEndpointDetails,
+    "UpdateDataSourceDetails": UpdateDataSourceDetails,
+    "UpdateKnowledgeBaseDetails": UpdateKnowledgeBaseDetails,
+    "WorkRequest": WorkRequest,
+    "WorkRequestError": WorkRequestError,
+    "WorkRequestErrorCollection": WorkRequestErrorCollection,
+    "WorkRequestLogEntry": WorkRequestLogEntry,
+    "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection,
+    "WorkRequestResource": WorkRequestResource,
+    "WorkRequestSummary": WorkRequestSummary,
+    "WorkRequestSummaryCollection": WorkRequestSummaryCollection
+}

oci/generative_ai_agent/models/agent.py

@@ -0,0 +1,536 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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 Agent(object):
+    """
+    **Agent**
+
+    An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses.
+
+    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see `Getting Started with Policies`__.
+
+    __ https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm
+    """
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "UPDATING"
+    LIFECYCLE_STATE_UPDATING = "UPDATING"
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    #: A constant which can be used with the lifecycle_state property of a Agent.
+    #: This constant has a value of "FAILED"
+    LIFECYCLE_STATE_FAILED = "FAILED"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Agent 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 Agent.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this Agent.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this Agent.
+        :type description: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this Agent.
+        :type compartment_id: str
+
+        :param knowledge_base_ids:
+            The value to assign to the knowledge_base_ids property of this Agent.
+        :type knowledge_base_ids: list[str]
+
+        :param welcome_message:
+            The value to assign to the welcome_message property of this Agent.
+        :type welcome_message: str
+
+        :param time_created:
+            The value to assign to the time_created property of this Agent.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this Agent.
+        :type time_updated: datetime
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this Agent.
+            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this Agent.
+        :type lifecycle_details: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this Agent.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this Agent.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this Agent.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'compartment_id': 'str',
+            'knowledge_base_ids': 'list[str]',
+            'welcome_message': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'lifecycle_state': 'str',
+            'lifecycle_details': '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',
+            'display_name': 'displayName',
+            'description': 'description',
+            'compartment_id': 'compartmentId',
+            'knowledge_base_ids': 'knowledgeBaseIds',
+            'welcome_message': 'welcomeMessage',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'lifecycle_state': 'lifecycleState',
+            'lifecycle_details': 'lifecycleDetails',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags'
+        }
+
+        self._id = None
+        self._display_name = None
+        self._description = None
+        self._compartment_id = None
+        self._knowledge_base_ids = None
+        self._welcome_message = None
+        self._time_created = None
+        self._time_updated = None
+        self._lifecycle_state = None
+        self._lifecycle_details = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this Agent.
+        The `OCID`__ of the agent.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this Agent.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this Agent.
+        The `OCID`__ of the agent.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this Agent.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this Agent.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this Agent.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this Agent.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this Agent.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this Agent.
+        Description about the agent.
+
+
+        :return: The description of this Agent.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this Agent.
+        Description about the agent.
+
+
+        :param description: The description of this Agent.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this Agent.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this Agent.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this Agent.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this Agent.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def knowledge_base_ids(self):
+        """
+        Gets the knowledge_base_ids of this Agent.
+        List of `OCID`__ of the knowledgeBases associated with agent.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The knowledge_base_ids of this Agent.
+        :rtype: list[str]
+        """
+        return self._knowledge_base_ids
+
+    @knowledge_base_ids.setter
+    def knowledge_base_ids(self, knowledge_base_ids):
+        """
+        Sets the knowledge_base_ids of this Agent.
+        List of `OCID`__ of the knowledgeBases associated with agent.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param knowledge_base_ids: The knowledge_base_ids of this Agent.
+        :type: list[str]
+        """
+        self._knowledge_base_ids = knowledge_base_ids
+
+    @property
+    def welcome_message(self):
+        """
+        Gets the welcome_message of this Agent.
+        Details about purpose and responsibility of the agent
+
+
+        :return: The welcome_message of this Agent.
+        :rtype: str
+        """
+        return self._welcome_message
+
+    @welcome_message.setter
+    def welcome_message(self, welcome_message):
+        """
+        Sets the welcome_message of this Agent.
+        Details about purpose and responsibility of the agent
+
+
+        :param welcome_message: The welcome_message of this Agent.
+        :type: str
+        """
+        self._welcome_message = welcome_message
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this Agent.
+        The date and time the agent 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 Agent.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this Agent.
+        The date and time the agent 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 Agent.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        Gets the time_updated of this Agent.
+        The date and time the agent 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 Agent.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this Agent.
+        The date and time the agent 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 Agent.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this Agent.
+        The current state of the agent.
+
+        Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_state of this Agent.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this Agent.
+        The current state of the agent.
+
+
+        :param lifecycle_state: The lifecycle_state of this Agent.
+        :type: str
+        """
+        allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"]
+        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
+            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def lifecycle_details(self):
+        """
+        Gets the lifecycle_details of this Agent.
+        A message that describes the current state of the agent in more detail. For example,
+        can be used to provide actionable information for a resource in the Failed state.
+
+
+        :return: The lifecycle_details of this Agent.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets the lifecycle_details of this Agent.
+        A message that describes the current state of the agent in more detail. For example,
+        can be used to provide actionable information for a resource in the Failed state.
+
+
+        :param lifecycle_details: The lifecycle_details of this Agent.
+        :type: str
+        """
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this Agent.
+        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 Agent.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this Agent.
+        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 Agent.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this Agent.
+        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 Agent.
+        :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 Agent.
+        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 Agent.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this Agent.
+        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 Agent.
+        :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 Agent.
+        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 Agent.
+        :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