oci 2.139.0__py3-none-any.whl → 2.141.0__py3-none-any.whl

oci/generative_ai_agent/models/basic_auth_secret.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BasicAuthSecret(SecretDetail):
     """
-    **BasicAuthSecret**
-
     The details of Basic authentication configured as in OpenSearch.
     """
 

oci/generative_ai_agent/models/change_agent_compartment_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeAgentCompartmentDetails(object):
     """
-    **ChangeAgentCompartmentDetails**
-
     The configuration details for the move operation.
     """
 

oci/generative_ai_agent/models/change_agent_endpoint_compartment_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeAgentEndpointCompartmentDetails(object):
     """
-    **ChangeAgentEndpointCompartmentDetails**
-
     The configuration details for the move operation.
     """
 

oci/generative_ai_agent/models/change_knowledge_base_compartment_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeKnowledgeBaseCompartmentDetails(object):
     """
-    **ChangeKnowledgeBaseCompartmentDetails**
-
     The configuration details for the move operation.
     """
 

oci/generative_ai_agent/models/create_agent_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateAgentDetails(object):
     """
-    **CreateAgentDetails**
-
     The data to create an agent.
     """
 

oci/generative_ai_agent/models/create_agent_endpoint_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateAgentEndpointDetails(object):
     """
-    **CreateAgentEndpointDetails**
-
     The data to create an endpoint.
     """
 

oci/generative_ai_agent/models/create_data_ingestion_job_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateDataIngestionJobDetails(object):
     """
-    **CreateDataIngestionJobDetails**
-
     The data to create a data ingestion job.
     """
 

oci/generative_ai_agent/models/create_data_source_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateDataSourceDetails(object):
     """
-    **CreateDataSourceDetails**
-
     The data to create a data source.
     """
 

oci/generative_ai_agent/models/create_knowledge_base_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateKnowledgeBaseDetails(object):
     """
-    **CreateKnowledgeBaseDetails**
-
     The data to create a knowledge base.
     """
 

oci/generative_ai_agent/models/data_ingestion_job.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataIngestionJob(object):
     """
-    **DataIngestionJob**
-
     When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base.
 
     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`__.
@@ -74,6 +72,10 @@ class DataIngestionJob(object):
             The value to assign to the data_source_id property of this DataIngestionJob.
         :type data_source_id: str
 
+        :param knowledge_base_id:
+            The value to assign to the knowledge_base_id property of this DataIngestionJob.
+        :type knowledge_base_id: str
+
         :param data_ingestion_job_statistics:
             The value to assign to the data_ingestion_job_statistics property of this DataIngestionJob.
         :type data_ingestion_job_statistics: oci.generative_ai_agent.models.DataIngestionJobStatistics
@@ -115,6 +117,7 @@ class DataIngestionJob(object):
             'description': 'str',
             'compartment_id': 'str',
             'data_source_id': 'str',
+            'knowledge_base_id': 'str',
             'data_ingestion_job_statistics': 'DataIngestionJobStatistics',
             'time_created': 'datetime',
             'time_updated': 'datetime',
@@ -131,6 +134,7 @@ class DataIngestionJob(object):
             'description': 'description',
             'compartment_id': 'compartmentId',
             'data_source_id': 'dataSourceId',
+            'knowledge_base_id': 'knowledgeBaseId',
             'data_ingestion_job_statistics': 'dataIngestionJobStatistics',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
@@ -146,6 +150,7 @@ class DataIngestionJob(object):
         self._description = None
         self._compartment_id = None
         self._data_source_id = None
+        self._knowledge_base_id = None
         self._data_ingestion_job_statistics = None
         self._time_created = None
         self._time_updated = None
@@ -287,6 +292,34 @@ class DataIngestionJob(object):
         """
         self._data_source_id = data_source_id
 
+    @property
+    def knowledge_base_id(self):
+        """
+        Gets the knowledge_base_id of this DataIngestionJob.
+        The `OCID`__ of the parent KnowledgeBase.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :return: The knowledge_base_id of this DataIngestionJob.
+        :rtype: str
+        """
+        return self._knowledge_base_id
+
+    @knowledge_base_id.setter
+    def knowledge_base_id(self, knowledge_base_id):
+        """
+        Sets the knowledge_base_id of this DataIngestionJob.
+        The `OCID`__ of the parent KnowledgeBase.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+
+        :param knowledge_base_id: The knowledge_base_id of this DataIngestionJob.
+        :type: str
+        """
+        self._knowledge_base_id = knowledge_base_id
+
     @property
     def data_ingestion_job_statistics(self):
         """

oci/generative_ai_agent/models/data_ingestion_job_collection.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataIngestionJobCollection(object):
     """
-    **DataIngestionJobCollection**
-
     Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata.
     """
 

oci/generative_ai_agent/models/data_ingestion_job_statistics.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataIngestionJobStatistics(object):
     """
-    **DataIngestionJobStatistics**
-
     The statistics of data ingestion job.
     """
 

oci/generative_ai_agent/models/data_ingestion_job_summary.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataIngestionJobSummary(object):
     """
-    **DataIngestionJobSummary**
-
     Summary information about a data ingestion job.
     """
 

oci/generative_ai_agent/models/data_source.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataSource(object):
     """
-    **DataSource**
-
     A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data.
 
     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`__.

oci/generative_ai_agent/models/data_source_collection.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataSourceCollection(object):
     """
-    **DataSourceCollection**
-
     Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata.
     """
 

oci/generative_ai_agent/models/data_source_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataSourceConfig(object):
     """
-    **DataSourceConfig**
-
     The details of data source.
     """
 
@@ -30,6 +28,10 @@ class DataSourceConfig(object):
 
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
+        :param should_enable_multi_modality:
+            The value to assign to the should_enable_multi_modality property of this DataSourceConfig.
+        :type should_enable_multi_modality: bool
+
         :param data_source_config_type:
             The value to assign to the data_source_config_type property of this DataSourceConfig.
             Allowed values for this property are: "OCI_OBJECT_STORAGE", 'UNKNOWN_ENUM_VALUE'.
@@ -38,13 +40,16 @@ class DataSourceConfig(object):
 
         """
         self.swagger_types = {
+            'should_enable_multi_modality': 'bool',
             'data_source_config_type': 'str'
         }
 
         self.attribute_map = {
+            'should_enable_multi_modality': 'shouldEnableMultiModality',
             'data_source_config_type': 'dataSourceConfigType'
         }
 
+        self._should_enable_multi_modality = None
         self._data_source_config_type = None
 
     @staticmethod
@@ -60,6 +65,30 @@ class DataSourceConfig(object):
         else:
             return 'DataSourceConfig'
 
+    @property
+    def should_enable_multi_modality(self):
+        """
+        Gets the should_enable_multi_modality of this DataSourceConfig.
+        Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion.
+
+
+        :return: The should_enable_multi_modality of this DataSourceConfig.
+        :rtype: bool
+        """
+        return self._should_enable_multi_modality
+
+    @should_enable_multi_modality.setter
+    def should_enable_multi_modality(self, should_enable_multi_modality):
+        """
+        Sets the should_enable_multi_modality of this DataSourceConfig.
+        Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion.
+
+
+        :param should_enable_multi_modality: The should_enable_multi_modality of this DataSourceConfig.
+        :type: bool
+        """
+        self._should_enable_multi_modality = should_enable_multi_modality
+
     @property
     def data_source_config_type(self):
         """

oci/generative_ai_agent/models/data_source_summary.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DataSourceSummary(object):
     """
-    **DataSourceSummary**
-
     Summary information about a data source.
     """
 

oci/generative_ai_agent/models/database_connection.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DatabaseConnection(object):
     """
-    **DatabaseConnection**
-
     The connection type for Databases.
     """
 

oci/generative_ai_agent/models/database_function.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DatabaseFunction(object):
     """
-    **DatabaseFunction**
-
     The details of Database function.
     """
 

oci/generative_ai_agent/models/database_tool_connection.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DatabaseToolConnection(DatabaseConnection):
     """
-    **DatabaseToolConnection**
-
     The details of the customer Database Tools Connection.
     """
 

oci/generative_ai_agent/models/default_index_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DefaultIndexConfig(IndexConfig):
     """
-    **DefaultIndexConfig**
-
     The default index is service managed vector store on behalf of the customer.
     """
 

oci/generative_ai_agent/models/idcs_secret.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class IdcsSecret(SecretDetail):
     """
-    **IdcsSecret**
-
     The details of IDCS configured as OpenID setting in OpenSearch.
     """
 

oci/generative_ai_agent/models/index.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Index(object):
     """
-    **Index**
-
     OCI OpenSearch index details.
     """
 

oci/generative_ai_agent/models/index_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class IndexConfig(object):
     """
-    **IndexConfig**
-
     The index configuration of Knowledge bases.
     """
 

oci/generative_ai_agent/models/index_schema.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class IndexSchema(object):
     """
-    **IndexSchema**
-
     The index schema details.
     """
 

oci/generative_ai_agent/models/knowledge_base.py

@@ -12,8 +12,6 @@ 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`__.
@@ -74,6 +72,10 @@ class KnowledgeBase(object):
             The value to assign to the index_config property of this KnowledgeBase.
         :type index_config: oci.generative_ai_agent.models.IndexConfig
 
+        :param knowledge_base_statistics:
+            The value to assign to the knowledge_base_statistics property of this KnowledgeBase.
+        :type knowledge_base_statistics: oci.generative_ai_agent.models.KnowledgeBaseStatistics
+
         :param time_created:
             The value to assign to the time_created property of this KnowledgeBase.
         :type time_created: datetime
@@ -111,6 +113,7 @@ class KnowledgeBase(object):
             'description': 'str',
             'compartment_id': 'str',
             'index_config': 'IndexConfig',
+            'knowledge_base_statistics': 'KnowledgeBaseStatistics',
             'time_created': 'datetime',
             'time_updated': 'datetime',
             'lifecycle_state': 'str',
@@ -126,6 +129,7 @@ class KnowledgeBase(object):
             'description': 'description',
             'compartment_id': 'compartmentId',
             'index_config': 'indexConfig',
+            'knowledge_base_statistics': 'knowledgeBaseStatistics',
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
             'lifecycle_state': 'lifecycleState',
@@ -140,6 +144,7 @@ class KnowledgeBase(object):
         self._description = None
         self._compartment_id = None
         self._index_config = None
+        self._knowledge_base_statistics = None
         self._time_created = None
         self._time_updated = None
         self._lifecycle_state = None
@@ -272,6 +277,26 @@ class KnowledgeBase(object):
         """
         self._index_config = index_config
 
+    @property
+    def knowledge_base_statistics(self):
+        """
+        Gets the knowledge_base_statistics of this KnowledgeBase.
+
+        :return: The knowledge_base_statistics of this KnowledgeBase.
+        :rtype: oci.generative_ai_agent.models.KnowledgeBaseStatistics
+        """
+        return self._knowledge_base_statistics
+
+    @knowledge_base_statistics.setter
+    def knowledge_base_statistics(self, knowledge_base_statistics):
+        """
+        Sets the knowledge_base_statistics of this KnowledgeBase.
+
+        :param knowledge_base_statistics: The knowledge_base_statistics of this KnowledgeBase.
+        :type: oci.generative_ai_agent.models.KnowledgeBaseStatistics
+        """
+        self._knowledge_base_statistics = knowledge_base_statistics
+
     @property
     def time_created(self):
         """

oci/generative_ai_agent/models/knowledge_base_collection.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class KnowledgeBaseCollection(object):
     """
-    **KnowledgeBaseCollection**
-
     Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata.
     """
 

oci/generative_ai_agent/models/knowledge_base_statistics.py

@@ -0,0 +1,72 @@
+# 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 KnowledgeBaseStatistics(object):
+    """
+    Statistics for Default Knowledge Base.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new KnowledgeBaseStatistics object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param size_in_bytes:
+            The value to assign to the size_in_bytes property of this KnowledgeBaseStatistics.
+        :type size_in_bytes: int
+
+        """
+        self.swagger_types = {
+            'size_in_bytes': 'int'
+        }
+
+        self.attribute_map = {
+            'size_in_bytes': 'sizeInBytes'
+        }
+
+        self._size_in_bytes = None
+
+    @property
+    def size_in_bytes(self):
+        """
+        Gets the size_in_bytes of this KnowledgeBaseStatistics.
+        Knowledge Base size in bytes.
+
+
+        :return: The size_in_bytes of this KnowledgeBaseStatistics.
+        :rtype: int
+        """
+        return self._size_in_bytes
+
+    @size_in_bytes.setter
+    def size_in_bytes(self, size_in_bytes):
+        """
+        Sets the size_in_bytes of this KnowledgeBaseStatistics.
+        Knowledge Base size in bytes.
+
+
+        :param size_in_bytes: The size_in_bytes of this KnowledgeBaseStatistics.
+        :type: int
+        """
+        self._size_in_bytes = size_in_bytes
+
+    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_summary.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class KnowledgeBaseSummary(object):
     """
-    **KnowledgeBaseSummary**
-
     Summary information about a knowledge base.
     """
 

oci/generative_ai_agent/models/object_storage_prefix.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ObjectStoragePrefix(object):
     """
-    **ObjectStoragePrefix**
-
     The details of OCI Object Storage object.
     """
 

oci/generative_ai_agent/models/oci_database_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class OciDatabaseConfig(IndexConfig):
     """
-    **OciDatabaseConfig**
-
     The details of the customer Database Connection.
     """
 

oci/generative_ai_agent/models/oci_object_storage_data_source_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class OciObjectStorageDataSourceConfig(DataSourceConfig):
     """
-    **OciObjectStorageDataSourceConfig**
-
     The details of OCI Search with OpenSearch data source information.
     """
 
@@ -23,6 +21,10 @@ class OciObjectStorageDataSourceConfig(DataSourceConfig):
         of this class is ``OCI_OBJECT_STORAGE`` and it should not be changed.
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
+        :param should_enable_multi_modality:
+            The value to assign to the should_enable_multi_modality property of this OciObjectStorageDataSourceConfig.
+        :type should_enable_multi_modality: bool
+
         :param data_source_config_type:
             The value to assign to the data_source_config_type property of this OciObjectStorageDataSourceConfig.
             Allowed values for this property are: "OCI_OBJECT_STORAGE"
@@ -34,15 +36,18 @@ class OciObjectStorageDataSourceConfig(DataSourceConfig):
 
         """
         self.swagger_types = {
+            'should_enable_multi_modality': 'bool',
             'data_source_config_type': 'str',
             'object_storage_prefixes': 'list[ObjectStoragePrefix]'
         }
 
         self.attribute_map = {
+            'should_enable_multi_modality': 'shouldEnableMultiModality',
             'data_source_config_type': 'dataSourceConfigType',
             'object_storage_prefixes': 'objectStoragePrefixes'
         }
 
+        self._should_enable_multi_modality = None
         self._data_source_config_type = None
         self._object_storage_prefixes = None
         self._data_source_config_type = 'OCI_OBJECT_STORAGE'
@@ -50,7 +55,7 @@ class OciObjectStorageDataSourceConfig(DataSourceConfig):
     @property
     def object_storage_prefixes(self):
         """
-        **[Required]** Gets the object_storage_prefixes of this OciObjectStorageDataSourceConfig.
+        Gets the object_storage_prefixes of this OciObjectStorageDataSourceConfig.
         The locations of data items in Object Storage, can either be an object (File) or a prefix (folder).
 
 

oci/generative_ai_agent/models/oci_open_search_index_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class OciOpenSearchIndexConfig(IndexConfig):
     """
-    **OciOpenSearchIndexConfig**
-
     The details of customer managed OCI OpenSearch.
     """
 

oci/generative_ai_agent/models/secret_detail.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class SecretDetail(object):
     """
-    **SecretDetail**
-
     The details of configured security configuration on OpenSearch.
     """
 

oci/generative_ai_agent/models/session_config.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class SessionConfig(object):
     """
-    **SessionConfig**
-
     Session Configuration on AgentEndpoint.
     """
 

oci/generative_ai_agent/models/update_agent_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UpdateAgentDetails(object):
     """
-    **UpdateAgentDetails**
-
     The data to update an agent.
     """
 

oci/generative_ai_agent/models/update_agent_endpoint_details.py

@@ -12,8 +12,6 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UpdateAgentEndpointDetails(object):
     """
-    **UpdateAgentEndpointDetails**
-
     The data to update an endpoint.
     """