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

oci/generative_ai_agent/models/index_schema.py

@@ -0,0 +1,167 @@
+# 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 IndexSchema(object):
+    """
+    **IndexSchema**
+
+    The index schema details.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new IndexSchema object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param body_key:
+            The value to assign to the body_key property of this IndexSchema.
+        :type body_key: str
+
+        :param url_key:
+            The value to assign to the url_key property of this IndexSchema.
+        :type url_key: str
+
+        :param title_key:
+            The value to assign to the title_key property of this IndexSchema.
+        :type title_key: str
+
+        :param embedding_body_key:
+            The value to assign to the embedding_body_key property of this IndexSchema.
+        :type embedding_body_key: str
+
+        """
+        self.swagger_types = {
+            'body_key': 'str',
+            'url_key': 'str',
+            'title_key': 'str',
+            'embedding_body_key': 'str'
+        }
+
+        self.attribute_map = {
+            'body_key': 'bodyKey',
+            'url_key': 'urlKey',
+            'title_key': 'titleKey',
+            'embedding_body_key': 'embeddingBodyKey'
+        }
+
+        self._body_key = None
+        self._url_key = None
+        self._title_key = None
+        self._embedding_body_key = None
+
+    @property
+    def body_key(self):
+        """
+        **[Required]** Gets the body_key of this IndexSchema.
+        Body key name.
+
+
+        :return: The body_key of this IndexSchema.
+        :rtype: str
+        """
+        return self._body_key
+
+    @body_key.setter
+    def body_key(self, body_key):
+        """
+        Sets the body_key of this IndexSchema.
+        Body key name.
+
+
+        :param body_key: The body_key of this IndexSchema.
+        :type: str
+        """
+        self._body_key = body_key
+
+    @property
+    def url_key(self):
+        """
+        Gets the url_key of this IndexSchema.
+        URL key that stores the URL of a document, if available.
+
+
+        :return: The url_key of this IndexSchema.
+        :rtype: str
+        """
+        return self._url_key
+
+    @url_key.setter
+    def url_key(self, url_key):
+        """
+        Sets the url_key of this IndexSchema.
+        URL key that stores the URL of a document, if available.
+
+
+        :param url_key: The url_key of this IndexSchema.
+        :type: str
+        """
+        self._url_key = url_key
+
+    @property
+    def title_key(self):
+        """
+        Gets the title_key of this IndexSchema.
+        Title key that stores the Title of a document, if available.
+
+
+        :return: The title_key of this IndexSchema.
+        :rtype: str
+        """
+        return self._title_key
+
+    @title_key.setter
+    def title_key(self, title_key):
+        """
+        Sets the title_key of this IndexSchema.
+        Title key that stores the Title of a document, if available.
+
+
+        :param title_key: The title_key of this IndexSchema.
+        :type: str
+        """
+        self._title_key = title_key
+
+    @property
+    def embedding_body_key(self):
+        """
+        Gets the embedding_body_key of this IndexSchema.
+        Field within customer managed OCI OpenSearch document containing the vector embedding for queries.
+
+
+        :return: The embedding_body_key of this IndexSchema.
+        :rtype: str
+        """
+        return self._embedding_body_key
+
+    @embedding_body_key.setter
+    def embedding_body_key(self, embedding_body_key):
+        """
+        Sets the embedding_body_key of this IndexSchema.
+        Field within customer managed OCI OpenSearch document containing the vector embedding for queries.
+
+
+        :param embedding_body_key: The embedding_body_key of this IndexSchema.
+        :type: str
+        """
+        self._embedding_body_key = embedding_body_key
+
+    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/knowledge_base.py

@@ -0,0 +1,501 @@
+# 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 KnowledgeBase(object):
+    """
+    **KnowledgeBase**
+
+    A knowledge base is the base for all the data sources that an agent can use to retrieve information for its 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 KnowledgeBase.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "UPDATING"
+    LIFECYCLE_STATE_UPDATING = "UPDATING"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "INACTIVE"
+    LIFECYCLE_STATE_INACTIVE = "INACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    #: A constant which can be used with the lifecycle_state property of a KnowledgeBase.
+    #: This constant has a value of "FAILED"
+    LIFECYCLE_STATE_FAILED = "FAILED"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new KnowledgeBase 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 KnowledgeBase.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this KnowledgeBase.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this KnowledgeBase.
+        :type description: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this KnowledgeBase.
+        :type compartment_id: str
+
+        :param index_config:
+            The value to assign to the index_config property of this KnowledgeBase.
+        :type index_config: oci.generative_ai_agent.models.IndexConfig
+
+        :param time_created:
+            The value to assign to the time_created property of this KnowledgeBase.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this KnowledgeBase.
+        :type time_updated: datetime
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this KnowledgeBase.
+            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 KnowledgeBase.
+        :type lifecycle_details: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this KnowledgeBase.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this KnowledgeBase.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this KnowledgeBase.
+        :type system_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'compartment_id': 'str',
+            'index_config': 'IndexConfig',
+            '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',
+            'index_config': 'indexConfig',
+            '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._index_config = 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 KnowledgeBase.
+        The `OCID`__ of the knowledge base.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this KnowledgeBase.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this KnowledgeBase.
+        The `OCID`__ of the knowledge base.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this KnowledgeBase.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this KnowledgeBase.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :return: The display_name of this KnowledgeBase.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this KnowledgeBase.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+
+
+        :param display_name: The display_name of this KnowledgeBase.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def description(self):
+        """
+        Gets the description of this KnowledgeBase.
+        A description of the knowledge base.
+
+
+        :return: The description of this KnowledgeBase.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this KnowledgeBase.
+        A description of the knowledge base.
+
+
+        :param description: The description of this KnowledgeBase.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this KnowledgeBase.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this KnowledgeBase.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this KnowledgeBase.
+        The `OCID`__ of the compartment.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this KnowledgeBase.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def index_config(self):
+        """
+        **[Required]** Gets the index_config of this KnowledgeBase.
+
+        :return: The index_config of this KnowledgeBase.
+        :rtype: oci.generative_ai_agent.models.IndexConfig
+        """
+        return self._index_config
+
+    @index_config.setter
+    def index_config(self, index_config):
+        """
+        Sets the index_config of this KnowledgeBase.
+
+        :param index_config: The index_config of this KnowledgeBase.
+        :type: oci.generative_ai_agent.models.IndexConfig
+        """
+        self._index_config = index_config
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this KnowledgeBase.
+        The date and time the knowledge base 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 KnowledgeBase.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this KnowledgeBase.
+        The date and time the knowledge base 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 KnowledgeBase.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        Gets the time_updated of this KnowledgeBase.
+        The date and time the knowledge base 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 KnowledgeBase.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this KnowledgeBase.
+        The date and time the knowledge base 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 KnowledgeBase.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this KnowledgeBase.
+        The current state of the knowledge base.
+
+        Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 KnowledgeBase.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this KnowledgeBase.
+        The current state of the knowledge base.
+
+
+        :param lifecycle_state: The lifecycle_state of this KnowledgeBase.
+        :type: str
+        """
+        allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "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 KnowledgeBase.
+        A message that describes the current state of the knowledge base 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 KnowledgeBase.
+        :rtype: str
+        """
+        return self._lifecycle_details
+
+    @lifecycle_details.setter
+    def lifecycle_details(self, lifecycle_details):
+        """
+        Sets the lifecycle_details of this KnowledgeBase.
+        A message that describes the current state of the knowledge base 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 KnowledgeBase.
+        :type: str
+        """
+        self._lifecycle_details = lifecycle_details
+
+    @property
+    def freeform_tags(self):
+        """
+        **[Required]** Gets the freeform_tags of this KnowledgeBase.
+        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 KnowledgeBase.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this KnowledgeBase.
+        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 KnowledgeBase.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        **[Required]** Gets the defined_tags of this KnowledgeBase.
+        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 KnowledgeBase.
+        :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 KnowledgeBase.
+        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 KnowledgeBase.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    @property
+    def system_tags(self):
+        """
+        Gets the system_tags of this KnowledgeBase.
+        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 KnowledgeBase.
+        :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 KnowledgeBase.
+        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 KnowledgeBase.
+        :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