updated method names

Author: eavanvalkenburg

python/samples/concepts/memory/azure_ai_search_hotel_samples/1_interact_with_the_collection.py

@@ -28,8 +28,8 @@ async def main(query: str):
         record_type=HotelSampleClass, embedding_generator=OpenAITextEmbedding()
     ) as collection:
         # Check if the collection exists.
-        if not await collection.does_collection_exist():
-            await collection.create_collection(index=custom_index)
+        if not await collection.collection_exists():
+            await collection.ensure_collection_exists(index=custom_index)
         await collection.upsert(records)
         # get the first five records to check the upsert worked.
         results = await collection.get(order_by="HotelName", top=5)

python/samples/concepts/memory/complex_memory.py

@@ -153,7 +153,7 @@ async def main(collection: str, use_azure_openai: bool):
         # cleanup any existing collection
         await record_collection.ensure_collection_deleted()
         # create a new collection
-        await record_collection.create_collection()
+        await record_collection.ensure_collection_exists()
 
         record1 = DataModel(
             content="Semantic Kernel is awesome",

python/samples/concepts/rag/self_critique_rag.py

@@ -55,7 +55,7 @@ async def main() -> None:
 
         print("Creating index for memory...")
         await collection.ensure_collection_deleted()
-        await collection.create_collection()
+        await collection.ensure_collection_exists()
 
         print("Populating memory...")
         # Add information to the collection

python/semantic_kernel/connectors/azure_ai_search.py

@@ -463,7 +463,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return records
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create a new collection in Azure AI Search.
 
         Args:
@@ -489,7 +489,7 @@ async def create_collection(self, **kwargs) -> None:
         )
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         if "params" not in kwargs:
             kwargs["params"] = {"select": ["name"]}
         return self.collection_name in [

python/semantic_kernel/connectors/azure_cosmos_db.py

@@ -360,7 +360,7 @@ def __init__(
         )
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create a new collection in Azure CosmosDB for MongoDB.
 
         This first creates a collection, with the kwargs.
@@ -965,7 +965,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return deserialized_records
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         indexing_policy = kwargs.pop("indexing_policy", _create_default_indexing_policy_nosql(self.definition))
         vector_embedding_policy = kwargs.pop(
             "vector_embedding_policy", _create_default_vector_embedding_policy(self.definition)
@@ -983,7 +983,7 @@ async def create_collection(self, **kwargs) -> None:
             raise VectorStoreOperationException("Failed to create container.") from e
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         container_proxy = await self._get_container_proxy(self.collection_name, **kwargs)
         try:
             await container_proxy.read(**kwargs)

python/semantic_kernel/connectors/chroma.py

@@ -127,7 +127,7 @@ def _get_collection(self) -> Collection:
             raise RuntimeError(f"Failed to get collection {self.collection_name}") from e
 
     @override
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         """Check if the collection exists."""
         try:
             self.client.get_collection(name=self.collection_name, embedding_function=self.embedding_func)
@@ -136,7 +136,7 @@ async def does_collection_exist(self, **kwargs: Any) -> bool:
             return False
 
     @override
-    async def create_collection(self, **kwargs: Any) -> None:
+    async def ensure_collection_exists(self, **kwargs: Any) -> None:
         """Create the collection.
 
         Will create a metadata object with the hnsw arguments.

python/semantic_kernel/connectors/faiss.py

@@ -143,7 +143,7 @@ def _create_indexes(self, index: faiss.Index | None = None, indexes: dict[str, f
                 self.indexes_key_map.setdefault(vector_field.name, {})
 
     @override
-    async def create_collection(
+    async def ensure_collection_exists(
         self, index: faiss.Index | None = None, indexes: dict[str, faiss.Index] | None = None, **kwargs: Any
     ) -> None:
         """Create a collection.
@@ -200,7 +200,7 @@ async def ensure_collection_deleted(self, **kwargs: Any) -> None:
         await super().ensure_collection_deleted(**kwargs)
 
     @override
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         return bool(self.indexes)
 
     @override

python/semantic_kernel/connectors/in_memory.py

@@ -146,15 +146,15 @@ def _serialize_dicts_to_store_models(self, records: Sequence[dict[str, Any]], **
         return records
 
     @override
-    async def create_collection(self, **kwargs: Any) -> None:
+    async def ensure_collection_exists(self, **kwargs: Any) -> None:
         pass
 
     @override
     async def ensure_collection_deleted(self, **kwargs: Any) -> None:
         self.inner_storage = {}
 
     @override
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         return True
 
     @override

python/semantic_kernel/connectors/mongodb.py

@@ -315,7 +315,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return [self._reset_key_field(record) for record in records]
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create a new collection in MongoDB.
 
         This first creates a collection, with the kwargs.
@@ -328,7 +328,7 @@ async def create_collection(self, **kwargs) -> None:
         await collection.create_search_indexes(models=_create_index_definitions(self.definition, self.index_name))
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         return bool(await self._get_database().list_collection_names(filter={"name": self.collection_name}))
 
     @override

python/semantic_kernel/connectors/pinecone.py

@@ -187,7 +187,7 @@ def _validate_data_model(self):
             )
 
     @override
-    async def create_collection(self, **kwargs: Any) -> None:
+    async def ensure_collection_exists(self, **kwargs: Any) -> None:
         """Create the Pinecone collection.
 
         Args:
@@ -292,7 +292,7 @@ async def _load_index_client(self) -> None:
             )
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         """Check if the Pinecone collection exists."""
         exists = (
             await self.client.has_index(self.collection_name)
@@ -306,7 +306,7 @@ async def does_collection_exist(self, **kwargs) -> bool:
     @override
     async def ensure_collection_deleted(self, **kwargs: Any) -> None:
         """Delete the Pinecone collection."""
-        if not await self.does_collection_exist():
+        if not await self.collection_exists():
             if self.index or self.index_client:
                 self.index = None
                 self.index_client = None

python/semantic_kernel/connectors/postgres.py

@@ -556,7 +556,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return records
 
     @override
-    async def create_collection(self, **kwargs: Any) -> None:
+    async def ensure_collection_exists(self, **kwargs: Any) -> None:
         """Create a PostgreSQL table based on a dictionary of VectorStoreRecordField.
 
         Args:
@@ -621,7 +621,7 @@ async def create_collection(self, **kwargs: Any) -> None:
             await self._create_index(table_name, vector_field)
 
     @override
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         """Check if the collection exists."""
         if self.connection_pool is None:
             raise VectorStoreOperationException(

python/semantic_kernel/connectors/qdrant.py

@@ -478,7 +478,7 @@ def _deserialize_store_models_to_dicts(
         ]
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create a new collection in Qdrant.
 
         Args:
@@ -521,7 +521,7 @@ async def create_collection(self, **kwargs) -> None:
         await self.qdrant_client.create_collection(**kwargs)
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         return await self.qdrant_client.collection_exists(self.collection_name, **kwargs)
 
     @override

python/semantic_kernel/connectors/redis.py

@@ -258,7 +258,7 @@ def _unget_redis_key(self, key: TKey) -> TKey:
         return key
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create a new index in Redis.
 
         Args:
@@ -283,7 +283,7 @@ async def create_collection(self, **kwargs) -> None:
         await self.redis_database.ft(self.collection_name).create_index(fields, definition=index_definition, **kwargs)
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         try:
             await self.redis_database.ft(self.collection_name).info()
             return True
@@ -292,7 +292,7 @@ async def does_collection_exist(self, **kwargs) -> bool:
 
     @override
     async def ensure_collection_deleted(self, **kwargs) -> None:
-        exists = await self.does_collection_exist()
+        exists = await self.collection_exists()
         if exists:
             await self.redis_database.ft(self.collection_name).dropindex(**kwargs)
         else:

python/semantic_kernel/connectors/sql_server.py

@@ -449,7 +449,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return records
 
     @override
-    async def create_collection(
+    async def ensure_collection_exists(
         self, *, create_if_not_exists: bool = True, queries: list[str] | None = None, **kwargs: Any
     ) -> None:
         """Create a SQL table based on the data model.
@@ -495,7 +495,7 @@ def _get_schema_and_table(self) -> tuple[str, str]:
         return schema, table
 
     @override
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         """Check if the collection exists."""
         if self.connection is None:
             raise VectorStoreOperationException("connection is not available, use the collection as a context manager.")

python/semantic_kernel/connectors/weaviate.py

@@ -551,7 +551,7 @@ def _deserialize_store_models_to_dicts(self, records: Sequence[Any], **kwargs: A
         return records_in_dict
 
     @override
-    async def create_collection(self, **kwargs) -> None:
+    async def ensure_collection_exists(self, **kwargs) -> None:
         """Create the collection in Weaviate.
 
         Args:
@@ -619,7 +619,7 @@ async def create_collection(self, **kwargs) -> None:
             raise VectorStoreOperationException(f"Failed to create collection: {ex}") from ex
 
     @override
-    async def does_collection_exist(self, **kwargs) -> bool:
+    async def collection_exists(self, **kwargs) -> bool:
         """Check if the collection exists in Weaviate.
 
         Args:

python/semantic_kernel/data/vector.py

@@ -1241,37 +1241,12 @@ async def _inner_delete(self, keys: Sequence[TKey], **kwargs: Any) -> None:
         """
         ...  # pragma: no cover
 
-    async def delete_create_collection(self, **kwargs: Any) -> None:
-        """Create the collection in the service, after first trying to delete it.
-
-        First uses does_collection_exist to check if it exists, if it does deletes it.
-        Then, creates the collection.
-
-        """
-        if await self.does_collection_exist(**kwargs):
-            await self.ensure_collection_deleted(**kwargs)
-        await self.create_collection(**kwargs)
-
-    async def ensure_collection_exists(self, **kwargs: Any) -> bool:
-        """Create the collection in the service if it does not exists.
-
-        First uses does_collection_exist to check if it exists, if it does returns False.
-        Otherwise, creates the collection and returns True.
-
-        Returns:
-            bool: True if the collection was created, False if it already exists.
-
-        """
-        if await self.does_collection_exist(**kwargs):
-            return False
-        await self.create_collection(**kwargs)
-        return True
-
     @abstractmethod
-    async def create_collection(self, **kwargs: Any) -> None:
+    async def ensure_collection_exists(self, **kwargs: Any) -> None:
         """Create the collection in the service.
 
-        This should be overridden by the child class.
+        This should be overridden by the child class. Should first check if the collection exists,
+        if it does not, it should create the collection.
 
         Raises:
             Make sure the implementation of this function raises relevant exceptions with good descriptions.
@@ -1281,7 +1256,7 @@ async def create_collection(self, **kwargs: Any) -> None:
         ...  # pragma: no cover
 
     @abstractmethod
-    async def does_collection_exist(self, **kwargs: Any) -> bool:
+    async def collection_exists(self, **kwargs: Any) -> bool:
         """Check if the collection exists.
 
         This should be overridden by the child class.
@@ -1605,7 +1580,7 @@ async def does_collection_exist(self, collection_name: str) -> bool:
         try:
             data_model = VectorStoreCollectionDefinition(fields=[VectorStoreField("key", name="id")])
             collection = self.get_collection(record_type=dict, definition=data_model, collection_name=collection_name)
-            return await collection.does_collection_exist()
+            return await collection.collection_exists()
         except VectorStoreOperationException:
             return False
 

python/tests/integration/memory/postgres/test_postgres_int.py

@@ -112,7 +112,7 @@ async def create_simple_collection(
     collection_id = f"test_collection_{suffix}"
     collection = vector_store.get_collection(collection_name=collection_id, record_type=SimpleDataModel)
     assert isinstance(collection, PostgresCollection)
-    await collection.create_collection()
+    await collection.ensure_collection_exists()
     try:
         yield collection
     finally:

python/tests/unit/connectors/memory/azure_cosmos_db/test_azure_cosmos_db_mongodb_collection.py

@@ -84,7 +84,7 @@ async def test_create_collection_calls_database_methods(definition) -> None:
     )
 
     # Act
-    await collection.create_collection(customArg="customValue")
+    await collection.ensure_collection_exists(customArg="customValue")
 
     # Assert
     mock_database.create_collection.assert_awaited_once_with("test_collection", customArg="customValue")

python/tests/unit/connectors/memory/azure_cosmos_db/test_azure_cosmos_db_no_sql_collection.py

@@ -226,7 +226,7 @@ async def test_azure_cosmos_db_no_sql_collection_create_collection(
 
     mock_database_proxy.create_container_if_not_exists = AsyncMock(return_value=None)
 
-    await vector_collection.create_collection()
+    await vector_collection.ensure_collection_exists()
 
     mock_database_proxy.create_container_if_not_exists.assert_called_once_with(
         id=collection_name,
@@ -256,7 +256,7 @@ async def test_azure_cosmos_db_no_sql_collection_create_collection_allow_custom_
 
     mock_database_proxy.create_container_if_not_exists = AsyncMock(return_value=None)
 
-    await vector_collection.create_collection(indexing_policy={"automatic": False})
+    await vector_collection.ensure_collection_exists(indexing_policy={"automatic": False})
 
     mock_database_proxy.create_container_if_not_exists.assert_called_once_with(
         id=collection_name,
@@ -286,7 +286,7 @@ async def test_azure_cosmos_db_no_sql_collection_create_collection_allow_custom_
 
     mock_database_proxy.create_container_if_not_exists = AsyncMock(return_value=None)
 
-    await vector_collection.create_collection(vector_embedding_policy={"vectorEmbeddings": []})
+    await vector_collection.ensure_collection_exists(vector_embedding_policy={"vectorEmbeddings": []})
 
     mock_database_proxy.create_container_if_not_exists.assert_called_once_with(
         id=collection_name,
@@ -323,7 +323,7 @@ async def test_azure_cosmos_db_no_sql_collection_create_collection_unsupported_v
     mock_database_proxy.create_container_if_not_exists = AsyncMock(return_value=None)
 
     with pytest.raises(VectorStoreModelException):
-        await vector_collection.create_collection()
+        await vector_collection.ensure_collection_exists()
 
 
 @patch("azure.cosmos.aio.DatabaseProxy")

python/tests/unit/connectors/memory/mongodb_atlas/test_mongodb_atlas_collection.py

@@ -90,4 +90,4 @@ async def test_mongodb_atlas_collection_collection_exists(mongodb_atlas_unit_tes
     )
     with patch.object(collection, "_get_database", new=mock_get_database) as mock_get:
         mock_get.return_value.list_collection_names.return_value = ["test_collection"]
-        assert await collection.does_collection_exist()
+        assert await collection.collection_exists()