diff --git a/docs/source/route_layer/sync.rst b/docs/source/route_layer/sync.rst index 03204917..efb1bebe 100644 --- a/docs/source/route_layer/sync.rst +++ b/docs/source/route_layer/sync.rst @@ -67,4 +67,10 @@ You can try this yourself by running the following: rl = RouteLayer(encoder=encoder, routes=routes, index=pc_index) -When initializing the `PineconeIndex` object, we can specify the `sync` parameter. \ No newline at end of file +When initializing the `PineconeIndex` object, we can specify the `sync` parameter. + +Checking for Synchronization +---------------------------- + +To verify whether the local and remote instances are synchronized, you can use the `is_synced` method. This method checks if the routes, utterances, and associated metadata in the local instance match those stored in the remote index. +Consider that if the `sync` flag is not set (e.g. for indexes different from Pinecone), it raises an error. If the index supports sync feature and everything aligns, it returns `True`, indicating that the local and remote instances are synchronized, otherwise it returns `False`. \ No newline at end of file