Skip to content

WeaviateClient

ClientManager

Handles the creation and management of the Weaviate client. Handles cases where the client can be used in more than one thread or async operation at a time, via threading and asyncio locks. Also can use methods for restarting client if its been inactive.

Source code in elysia/util/client.py 
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
class ClientManager:
    """
    Handles the creation and management of the Weaviate client.
    Handles cases where the client can be used in more than one thread or async operation at a time,
    via threading and asyncio locks.
    Also can use methods for restarting client if its been inactive.
    """

    def __init__(
        self,
        wcd_url: str | None = None,
        wcd_api_key: str | None = None,
        client_timeout: datetime.timedelta | int | None = None,
        logger: Logger | None = None,
        settings: Settings | None = None,
        **kwargs,
    ) -> None:
        """
        Args:
            wcd_url (str): the url of the Weaviate cluster. Defaults to global settings config.
            wcd_api_key (str): the api key for the Weaviate cluster. Defaults to global settings config.
            client_timeout (datetime.timedelta | int | None): how long (in minutes) means the client should be restarted. Defaults to 3 minutes.
            logger (Logger | None): a logger object for logging messages. Defaults to None.
            settings (Settings | None): a settings object for the client manager. Defaults to environment settings.
            **kwargs (Any): any other api keys for third party services (formatted as e.g. OPENAI_APIKEY).

        Example:
        ```python
        client_manager = ClientManager(
            wcd_url="https://my-weaviate-cluster...",
            wcd_api_key="my-api-key...",
            OPENAI_APIKEY="my-openai-api-key...",
            HUGGINGFACE_APIKEY="my-huggingface-api-key...",
        )
        ```
        """

        self.logger = logger

        if client_timeout is None:
            self.client_timeout = datetime.timedelta(
                minutes=int(os.getenv("CLIENT_TIMEOUT", 3))
            )
        elif isinstance(client_timeout, int):
            self.client_timeout = datetime.timedelta(minutes=client_timeout)
        else:
            self.client_timeout = client_timeout

        if settings is None:
            self.settings = environment_settings
        else:
            self.settings = settings

        # Set the weaviate cluster url and api key
        if wcd_url is None:
            self.wcd_url = self.settings.WCD_URL
        else:
            self.wcd_url = wcd_url

        if wcd_api_key is None:
            self.wcd_api_key = self.settings.WCD_API_KEY
        else:
            self.wcd_api_key = wcd_api_key

        # Set the api keys for non weaviate cluster (third parties)
        self.headers = {}
        for api_key in self.settings.API_KEYS:
            if api_key.lower() in [a.lower() for a in api_key_map.keys()]:
                self.headers[api_key_map[api_key.upper()]] = self.settings.API_KEYS[
                    api_key
                ]

        # From kwargs
        for kwarg in kwargs:
            if kwarg.lower() in [a.lower() for a in api_key_map.keys()]:
                self.headers[api_key_map[kwarg.upper()]] = kwargs[kwarg]

        # Create locks for client events
        self.async_lock = asyncio.Lock()
        self.sync_lock = threading.Lock()

        # In use counter tracks when the client is in use and by how many operations. 0 = can restart
        self.async_in_use_counter = 0
        self.sync_in_use_counter = 0
        self.async_restart_event = asyncio.Event()
        self.sync_restart_event = threading.Event()

        self.last_used_sync_client = datetime.datetime.now()
        self.last_used_async_client = datetime.datetime.now()

        self.async_client = None
        self.async_init_completed = False
        self.is_client = self.wcd_url != "" and self.wcd_api_key != ""

        if self.logger:
            if self.wcd_api_key == "" and self.wcd_url == "":
                self.logger.warning(
                    "WCD_URL and WCD_API_KEY are not set. "
                    "All Weaviate functionality will be disabled."
                )
            elif self.wcd_url == "":
                self.logger.warning(
                    "WCD_URL is not set. "
                    "All Weaviate functionality will be disabled."
                )
            elif self.wcd_api_key == "":
                self.logger.warning(
                    "WCD_API_KEY is not set. "
                    "All Weaviate functionality will be disabled."
                )
            else:
                self.logger.debug(
                    "Weaviate client initialised. "
                    "All Weaviate functionality will be enabled."
                )

        if not self.is_client:
            return

        # Start sync client
        self.client = self.get_client()
        self.sync_restart_event.set()

    async def reset_keys(
        self,
        wcd_url: str | None = None,
        wcd_api_key: str | None = None,
        api_keys: dict[str, str] = {},
    ) -> None:
        """
        Set the API keys, WCD_URL and WCD_API_KEY from the settings object.

        Args:
            wcd_url (str): the url of the Weaviate cluster.
            wcd_api_key (str): the api key for the Weaviate cluster.
            api_keys (dict): a dictionary of api keys for third party services.
        """
        self.wcd_url = wcd_url
        self.wcd_api_key = wcd_api_key

        self.headers = {}

        for api_key in api_keys:
            if api_key.lower() in [a.lower() for a in api_key_map.keys()]:
                self.headers[api_key_map[api_key.upper()]] = api_keys[api_key]

        self.is_client = self.wcd_url != "" and self.wcd_api_key != ""
        if self.is_client:
            await self.restart_client(force=True)
            await self.restart_async_client(force=True)
            await self.start_clients()

    async def start_clients(self) -> None:
        """
        Start the async and sync clients if they are not already running.
        """

        if not self.is_client:
            raise ValueError(
                "Weaviate is not available. Please set the WCD_URL and WCD_API_KEY in the settings."
            )

        if self.async_client is None:
            self.async_client = await self.get_async_client()
            self.async_restart_event.set()

        if not self.async_client.is_connected():
            await self.async_client.connect()

        self.async_init_completed = True

        if not self.client.is_connected():
            self.client.connect()

    def update_last_user_request(self) -> None:
        self.last_user_request = datetime.datetime.now()

    def update_last_used_sync_client(self) -> None:
        self.last_used_sync_client = datetime.datetime.now()

    def update_last_used_async_client(self) -> None:
        self.last_used_async_client = datetime.datetime.now()

    def get_client(self) -> WeaviateClient:
        if self.wcd_url is None or self.wcd_api_key is None:
            raise ValueError("WCD_URL and WCD_API_KEY must be set")

        return weaviate.connect_to_weaviate_cloud(
            cluster_url=self.wcd_url,
            auth_credentials=Auth.api_key(self.wcd_api_key),
            headers=self.headers,
            skip_init_checks=True,
        )

    async def get_async_client(self) -> WeaviateAsyncClient:
        if self.wcd_url is None or self.wcd_api_key is None:
            raise ValueError("WCD_URL and WCD_API_KEY must be set")

        return weaviate.use_async_with_weaviate_cloud(
            cluster_url=self.wcd_url,
            auth_credentials=Auth.api_key(self.wcd_api_key),
            headers=self.headers,
            skip_init_checks=True,
        )

    @contextmanager
    def connect_to_client(self) -> Generator[WeaviateClient, Any, None]:
        """
        A context manager to connect to the _sync_ client.

        E.g.

        ```python
        with client_manager.connect_to_client():
            # do stuff with the weaviate client
            ...
        ```
        """
        self.sync_restart_event.wait()
        with self.sync_lock:
            self.sync_in_use_counter += 1

        if not self.client.is_connected():
            self.client.connect()

        connection = _ClientConnection(self, self.client)
        with connection:
            yield connection.client

    @asynccontextmanager
    async def connect_to_async_client(
        self,
    ) -> AsyncGenerator[WeaviateAsyncClient, Any]:
        """
        A context manager to connect to the _async_ client.

        E.g.
        ```python
        async with client_manager.connect_to_async_client():
            # do stuff with the async weaviate client
            ...
        ```
        """
        if not self.async_init_completed:
            await self.start_clients()

        await self.async_restart_event.wait()
        async with self.async_lock:
            self.async_in_use_counter += 1

        if self.async_client is None:
            raise ValueError("Async client not initialised")

        if not self.async_client.is_connected():
            await self.async_client.connect()

        connection = _AsyncClientConnection(self, self.async_client)
        async with connection:
            yield connection.client

    async def restart_async_client(self, force=False) -> None:
        """
        Restart the async client if it has not been used in the last client_timeout minutes (set in init).
        """
        if self.client_timeout == datetime.timedelta(minutes=0) and not force:
            return

        # First check if the client has been used in the last X minutes
        if (
            datetime.datetime.now() - self.last_used_async_client > self.client_timeout
            or force
        ):
            # Acquire lock before modifying shared state to prevent race conditions
            try:
                async with self.async_lock:
                    # Clear the event WHILE holding the lock to prevent new connections from starting
                    # This ensures no new connections can proceed until we're done
                    self.async_restart_event.clear()

                    # Record current counter value before waiting
                    last_recorded_counter = self.async_in_use_counter

                    # Set reasonable timeout values
                    time_spent = 0
                    max_wait_time = 10  # seconds
                    check_interval = 0.1  # seconds

                    # Only wait if there are active connections
                    if last_recorded_counter > 0:
                        # Wait for existing connections to complete
                        while self.async_in_use_counter > 0:
                            # Release lock during sleep to prevent deadlock
                            self.async_lock.release()

                            # Only timeout after 10 seconds if nothing is happening
                            # if the counter is changing, then things are happening and we should wait
                            if self.async_in_use_counter != last_recorded_counter:
                                last_recorded_counter = self.async_in_use_counter
                                time_spent = 0

                            try:
                                await asyncio.sleep(check_interval)
                                time_spent += check_interval
                                if time_spent > max_wait_time:
                                    if self.logger:
                                        self.logger.error(
                                            f"Async client restart timed out after {max_wait_time} seconds. "
                                        )
                                    break
                            finally:
                                # Re-acquire lock after sleep
                                await self.async_lock.acquire()

                    # Handle timeout case - must reset state regardless of timeout
                    if self.async_in_use_counter > 0:
                        if self.logger:
                            self.logger.error(
                                "Force resetting async client state due to timeout"
                            )
                        self.async_in_use_counter = 0

                    # Whether we timed out or not, we need to restart the client
                    try:
                        # Only close if client exists and is connected
                        if (
                            hasattr(self, "async_client")
                            and self.async_client is not None
                        ):
                            await self.async_client.close()
                        await asyncio.sleep(0.1)
                        # Create a new client instance
                        self.async_client = await self.get_async_client()
                    except Exception as e:
                        if self.logger:
                            self.logger.error(
                                f"Error during async client restart: {str(e)}"
                            )
                        # Create a new client anyway to ensure we have a valid client
                        self.async_client = await self.get_async_client()
                    finally:
                        # CRITICAL: Always set the event to prevent deadlocks
                        # This ensures waiting connections can proceed
                        self.async_restart_event.set()

            except Exception as e:
                if self.logger:
                    self.logger.error(
                        f"Unexpected error in async client restart: {str(e)}"
                    )
                # Ensure the event is set in all error cases
                self.async_restart_event.set()
                # Attempt to create a new client
                self.async_client = await self.get_async_client()

    async def restart_client(self, force=False) -> None:
        """
        Restart the sync client if it has not been used in the last client_timeout minutes (set in init).
        """
        if self.client_timeout == datetime.timedelta(minutes=0) and not force:
            return

        # First check if the client has been used in the last X minutes
        if (
            datetime.datetime.now() - self.last_used_sync_client > self.client_timeout
            or force
        ):
            # Use both locks to prevent any race conditions between sync and async operations
            try:
                # Acquire sync lock first
                with self.sync_lock:
                    # Clear event while holding the lock to prevent race conditions
                    self.sync_restart_event.clear()

                    # Record current counter value
                    last_recorded_counter = self.sync_in_use_counter

                    # Set reasonable timeout values
                    time_spent = 0
                    max_wait_time = 10  # seconds
                    check_interval = 0.1  # seconds

                    # Only wait if there are active connections
                    if last_recorded_counter > 0:
                        # Wait for existing connections to complete
                        while self.sync_in_use_counter > 0:
                            # Must release lock during async sleep to prevent deadlock
                            self.sync_lock.release()

                            # Only timeout after 10 seconds if nothing is happening
                            # if the counter is changing, then things are happening and we should wait
                            if self.sync_in_use_counter != last_recorded_counter:
                                last_recorded_counter = self.sync_in_use_counter
                                time_spent = 0

                            try:
                                await asyncio.sleep(check_interval)
                                time_spent += check_interval
                                if time_spent > max_wait_time:
                                    if self.logger:
                                        self.logger.error(
                                            f"Sync client restart timed out after {max_wait_time}s. "
                                            f"Initial counter: {last_recorded_counter}, Current: {self.sync_in_use_counter}"
                                        )
                                    break
                            finally:
                                # Re-acquire lock
                                self.sync_lock.acquire()

                    # Handle timeout case - must reset state regardless of timeout
                    if self.sync_in_use_counter > 0:
                        if self.logger:
                            self.logger.error(
                                "Force resetting sync client state due to timeout"
                            )
                        self.sync_in_use_counter = 0

                    # Whether we timed out or not, we need to restart the client
                    try:
                        # Only close if client exists and is connected
                        if hasattr(self, "client") and self.client is not None:
                            self.client.close()
                        await asyncio.sleep(0.1)
                        # Create a new client instance
                        self.client = self.get_client()
                    except Exception as e:
                        if self.logger:
                            self.logger.error(
                                f"Error during sync client restart: {str(e)}"
                            )
                        # Create a new client anyway
                        self.client = self.get_client()
                    finally:
                        # CRITICAL: Always set the event to prevent deadlocks
                        self.sync_restart_event.set()

            except Exception as e:
                if self.logger:
                    self.logger.error(
                        f"Unexpected error in sync client restart: {str(e)}"
                    )
                # Ensure the event is set in all error cases
                self.sync_restart_event.set()
                # Attempt to create a new client
                self.client = self.get_client()

    async def close_clients(self) -> None:
        """
        Close both the async and sync clients.
        Should not be called inside a Tool or other function inside the decision tree.
        """
        if hasattr(self, "async_client") and self.async_client is not None:
            await self.async_client.close()
        if hasattr(self, "client") and self.client is not None:
            self.client.close()

__init__(wcd_url=None, wcd_api_key=None, client_timeout=None, logger=None, settings=None, **kwargs)

Parameters:

Name Type Description Default
wcd_url str

the url of the Weaviate cluster. Defaults to global settings config.

 None
wcd_api_key str

the api key for the Weaviate cluster. Defaults to global settings config.

 None
client_timeout timedelta | int | None

how long (in minutes) means the client should be restarted. Defaults to 3 minutes.

 None
logger Logger | None

a logger object for logging messages. Defaults to None.

 None
settings Settings | None

a settings object for the client manager. Defaults to environment settings.

 None
**kwargs Any

any other api keys for third party services (formatted as e.g. OPENAI_APIKEY).

 {}

Example: 

client_manager = ClientManager(
    wcd_url="https://my-weaviate-cluster...",
    wcd_api_key="my-api-key...",
    OPENAI_APIKEY="my-openai-api-key...",
    HUGGINGFACE_APIKEY="my-huggingface-api-key...",
)

Source code in elysia/util/client.py 
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def __init__(
    self,
    wcd_url: str | None = None,
    wcd_api_key: str | None = None,
    client_timeout: datetime.timedelta | int | None = None,
    logger: Logger | None = None,
    settings: Settings | None = None,
    **kwargs,
) -> None:
    """
    Args:
        wcd_url (str): the url of the Weaviate cluster. Defaults to global settings config.
        wcd_api_key (str): the api key for the Weaviate cluster. Defaults to global settings config.
        client_timeout (datetime.timedelta | int | None): how long (in minutes) means the client should be restarted. Defaults to 3 minutes.
        logger (Logger | None): a logger object for logging messages. Defaults to None.
        settings (Settings | None): a settings object for the client manager. Defaults to environment settings.
        **kwargs (Any): any other api keys for third party services (formatted as e.g. OPENAI_APIKEY).

    Example:
    ```python
    client_manager = ClientManager(
        wcd_url="https://my-weaviate-cluster...",
        wcd_api_key="my-api-key...",
        OPENAI_APIKEY="my-openai-api-key...",
        HUGGINGFACE_APIKEY="my-huggingface-api-key...",
    )
    ```
    """

    self.logger = logger

    if client_timeout is None:
        self.client_timeout = datetime.timedelta(
            minutes=int(os.getenv("CLIENT_TIMEOUT", 3))
        )
    elif isinstance(client_timeout, int):
        self.client_timeout = datetime.timedelta(minutes=client_timeout)
    else:
        self.client_timeout = client_timeout

    if settings is None:
        self.settings = environment_settings
    else:
        self.settings = settings

    # Set the weaviate cluster url and api key
    if wcd_url is None:
        self.wcd_url = self.settings.WCD_URL
    else:
        self.wcd_url = wcd_url

    if wcd_api_key is None:
        self.wcd_api_key = self.settings.WCD_API_KEY
    else:
        self.wcd_api_key = wcd_api_key

    # Set the api keys for non weaviate cluster (third parties)
    self.headers = {}
    for api_key in self.settings.API_KEYS:
        if api_key.lower() in [a.lower() for a in api_key_map.keys()]:
            self.headers[api_key_map[api_key.upper()]] = self.settings.API_KEYS[
                api_key
            ]

    # From kwargs
    for kwarg in kwargs:
        if kwarg.lower() in [a.lower() for a in api_key_map.keys()]:
            self.headers[api_key_map[kwarg.upper()]] = kwargs[kwarg]

    # Create locks for client events
    self.async_lock = asyncio.Lock()
    self.sync_lock = threading.Lock()

    # In use counter tracks when the client is in use and by how many operations. 0 = can restart
    self.async_in_use_counter = 0
    self.sync_in_use_counter = 0
    self.async_restart_event = asyncio.Event()
    self.sync_restart_event = threading.Event()

    self.last_used_sync_client = datetime.datetime.now()
    self.last_used_async_client = datetime.datetime.now()

    self.async_client = None
    self.async_init_completed = False
    self.is_client = self.wcd_url != "" and self.wcd_api_key != ""

    if self.logger:
        if self.wcd_api_key == "" and self.wcd_url == "":
            self.logger.warning(
                "WCD_URL and WCD_API_KEY are not set. "
                "All Weaviate functionality will be disabled."
            )
        elif self.wcd_url == "":
            self.logger.warning(
                "WCD_URL is not set. "
                "All Weaviate functionality will be disabled."
            )
        elif self.wcd_api_key == "":
            self.logger.warning(
                "WCD_API_KEY is not set. "
                "All Weaviate functionality will be disabled."
            )
        else:
            self.logger.debug(
                "Weaviate client initialised. "
                "All Weaviate functionality will be enabled."
            )

    if not self.is_client:
        return

    # Start sync client
    self.client = self.get_client()
    self.sync_restart_event.set()

close_clients() async

Close both the async and sync clients. Should not be called inside a Tool or other function inside the decision tree.

Source code in elysia/util/client.py 
500
501
502
503
504
505
506
507
508
async def close_clients(self) -> None:
    """
    Close both the async and sync clients.
    Should not be called inside a Tool or other function inside the decision tree.
    """
    if hasattr(self, "async_client") and self.async_client is not None:
        await self.async_client.close()
    if hasattr(self, "client") and self.client is not None:
        self.client.close()

connect_to_async_client() async

A context manager to connect to the async client.

E.g. 

async with client_manager.connect_to_async_client():
    # do stuff with the async weaviate client
    ...

Source code in elysia/util/client.py 
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
@asynccontextmanager
async def connect_to_async_client(
    self,
) -> AsyncGenerator[WeaviateAsyncClient, Any]:
    """
    A context manager to connect to the _async_ client.

    E.g.
    ```python
    async with client_manager.connect_to_async_client():
        # do stuff with the async weaviate client
        ...
    ```
    """
    if not self.async_init_completed:
        await self.start_clients()

    await self.async_restart_event.wait()
    async with self.async_lock:
        self.async_in_use_counter += 1

    if self.async_client is None:
        raise ValueError("Async client not initialised")

    if not self.async_client.is_connected():
        await self.async_client.connect()

    connection = _AsyncClientConnection(self, self.async_client)
    async with connection:
        yield connection.client

connect_to_client()

A context manager to connect to the sync client.

E.g.

with client_manager.connect_to_client():
    # do stuff with the weaviate client
    ...
Source code in elysia/util/client.py 
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
@contextmanager
def connect_to_client(self) -> Generator[WeaviateClient, Any, None]:
    """
    A context manager to connect to the _sync_ client.

    E.g.

    ```python
    with client_manager.connect_to_client():
        # do stuff with the weaviate client
        ...
    ```
    """
    self.sync_restart_event.wait()
    with self.sync_lock:
        self.sync_in_use_counter += 1

    if not self.client.is_connected():
        self.client.connect()

    connection = _ClientConnection(self, self.client)
    with connection:
        yield connection.client

reset_keys(wcd_url=None, wcd_api_key=None, api_keys={}) async

Set the API keys, WCD_URL and WCD_API_KEY from the settings object.

Parameters:

Name Type Description Default
wcd_url str

the url of the Weaviate cluster.

 None
wcd_api_key str

the api key for the Weaviate cluster.

 None
api_keys dict

a dictionary of api keys for third party services.

 {}
Source code in elysia/util/client.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
async def reset_keys(
    self,
    wcd_url: str | None = None,
    wcd_api_key: str | None = None,
    api_keys: dict[str, str] = {},
) -> None:
    """
    Set the API keys, WCD_URL and WCD_API_KEY from the settings object.

    Args:
        wcd_url (str): the url of the Weaviate cluster.
        wcd_api_key (str): the api key for the Weaviate cluster.
        api_keys (dict): a dictionary of api keys for third party services.
    """
    self.wcd_url = wcd_url
    self.wcd_api_key = wcd_api_key

    self.headers = {}

    for api_key in api_keys:
        if api_key.lower() in [a.lower() for a in api_key_map.keys()]:
            self.headers[api_key_map[api_key.upper()]] = api_keys[api_key]

    self.is_client = self.wcd_url != "" and self.wcd_api_key != ""
    if self.is_client:
        await self.restart_client(force=True)
        await self.restart_async_client(force=True)
        await self.start_clients()

restart_async_client(force=False) async

Restart the async client if it has not been used in the last client_timeout minutes (set in init).

Source code in elysia/util/client.py 
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
async def restart_async_client(self, force=False) -> None:
    """
    Restart the async client if it has not been used in the last client_timeout minutes (set in init).
    """
    if self.client_timeout == datetime.timedelta(minutes=0) and not force:
        return

    # First check if the client has been used in the last X minutes
    if (
        datetime.datetime.now() - self.last_used_async_client > self.client_timeout
        or force
    ):
        # Acquire lock before modifying shared state to prevent race conditions
        try:
            async with self.async_lock:
                # Clear the event WHILE holding the lock to prevent new connections from starting
                # This ensures no new connections can proceed until we're done
                self.async_restart_event.clear()

                # Record current counter value before waiting
                last_recorded_counter = self.async_in_use_counter

                # Set reasonable timeout values
                time_spent = 0
                max_wait_time = 10  # seconds
                check_interval = 0.1  # seconds

                # Only wait if there are active connections
                if last_recorded_counter > 0:
                    # Wait for existing connections to complete
                    while self.async_in_use_counter > 0:
                        # Release lock during sleep to prevent deadlock
                        self.async_lock.release()

                        # Only timeout after 10 seconds if nothing is happening
                        # if the counter is changing, then things are happening and we should wait
                        if self.async_in_use_counter != last_recorded_counter:
                            last_recorded_counter = self.async_in_use_counter
                            time_spent = 0

                        try:
                            await asyncio.sleep(check_interval)
                            time_spent += check_interval
                            if time_spent > max_wait_time:
                                if self.logger:
                                    self.logger.error(
                                        f"Async client restart timed out after {max_wait_time} seconds. "
                                    )
                                break
                        finally:
                            # Re-acquire lock after sleep
                            await self.async_lock.acquire()

                # Handle timeout case - must reset state regardless of timeout
                if self.async_in_use_counter > 0:
                    if self.logger:
                        self.logger.error(
                            "Force resetting async client state due to timeout"
                        )
                    self.async_in_use_counter = 0

                # Whether we timed out or not, we need to restart the client
                try:
                    # Only close if client exists and is connected
                    if (
                        hasattr(self, "async_client")
                        and self.async_client is not None
                    ):
                        await self.async_client.close()
                    await asyncio.sleep(0.1)
                    # Create a new client instance
                    self.async_client = await self.get_async_client()
                except Exception as e:
                    if self.logger:
                        self.logger.error(
                            f"Error during async client restart: {str(e)}"
                        )
                    # Create a new client anyway to ensure we have a valid client
                    self.async_client = await self.get_async_client()
                finally:
                    # CRITICAL: Always set the event to prevent deadlocks
                    # This ensures waiting connections can proceed
                    self.async_restart_event.set()

        except Exception as e:
            if self.logger:
                self.logger.error(
                    f"Unexpected error in async client restart: {str(e)}"
                )
            # Ensure the event is set in all error cases
            self.async_restart_event.set()
            # Attempt to create a new client
            self.async_client = await self.get_async_client()

restart_client(force=False) async

Restart the sync client if it has not been used in the last client_timeout minutes (set in init).

Source code in elysia/util/client.py 
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
async def restart_client(self, force=False) -> None:
    """
    Restart the sync client if it has not been used in the last client_timeout minutes (set in init).
    """
    if self.client_timeout == datetime.timedelta(minutes=0) and not force:
        return

    # First check if the client has been used in the last X minutes
    if (
        datetime.datetime.now() - self.last_used_sync_client > self.client_timeout
        or force
    ):
        # Use both locks to prevent any race conditions between sync and async operations
        try:
            # Acquire sync lock first
            with self.sync_lock:
                # Clear event while holding the lock to prevent race conditions
                self.sync_restart_event.clear()

                # Record current counter value
                last_recorded_counter = self.sync_in_use_counter

                # Set reasonable timeout values
                time_spent = 0
                max_wait_time = 10  # seconds
                check_interval = 0.1  # seconds

                # Only wait if there are active connections
                if last_recorded_counter > 0:
                    # Wait for existing connections to complete
                    while self.sync_in_use_counter > 0:
                        # Must release lock during async sleep to prevent deadlock
                        self.sync_lock.release()

                        # Only timeout after 10 seconds if nothing is happening
                        # if the counter is changing, then things are happening and we should wait
                        if self.sync_in_use_counter != last_recorded_counter:
                            last_recorded_counter = self.sync_in_use_counter
                            time_spent = 0

                        try:
                            await asyncio.sleep(check_interval)
                            time_spent += check_interval
                            if time_spent > max_wait_time:
                                if self.logger:
                                    self.logger.error(
                                        f"Sync client restart timed out after {max_wait_time}s. "
                                        f"Initial counter: {last_recorded_counter}, Current: {self.sync_in_use_counter}"
                                    )
                                break
                        finally:
                            # Re-acquire lock
                            self.sync_lock.acquire()

                # Handle timeout case - must reset state regardless of timeout
                if self.sync_in_use_counter > 0:
                    if self.logger:
                        self.logger.error(
                            "Force resetting sync client state due to timeout"
                        )
                    self.sync_in_use_counter = 0

                # Whether we timed out or not, we need to restart the client
                try:
                    # Only close if client exists and is connected
                    if hasattr(self, "client") and self.client is not None:
                        self.client.close()
                    await asyncio.sleep(0.1)
                    # Create a new client instance
                    self.client = self.get_client()
                except Exception as e:
                    if self.logger:
                        self.logger.error(
                            f"Error during sync client restart: {str(e)}"
                        )
                    # Create a new client anyway
                    self.client = self.get_client()
                finally:
                    # CRITICAL: Always set the event to prevent deadlocks
                    self.sync_restart_event.set()

        except Exception as e:
            if self.logger:
                self.logger.error(
                    f"Unexpected error in sync client restart: {str(e)}"
                )
            # Ensure the event is set in all error cases
            self.sync_restart_event.set()
            # Attempt to create a new client
            self.client = self.get_client()

start_clients() async

Start the async and sync clients if they are not already running.

Source code in elysia/util/client.py 
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
async def start_clients(self) -> None:
    """
    Start the async and sync clients if they are not already running.
    """

    if not self.is_client:
        raise ValueError(
            "Weaviate is not available. Please set the WCD_URL and WCD_API_KEY in the settings."
        )

    if self.async_client is None:
        self.async_client = await self.get_async_client()
        self.async_restart_event.set()

    if not self.async_client.is_connected():
        await self.async_client.connect()

    self.async_init_completed = True

    if not self.client.is_connected():
        self.client.connect()