Adds get_httpx_client and get_async_httpx_client methods to simplyfy user experience

Author: mrDzurb

ads/aqua/__init__.py

@@ -7,7 +7,13 @@
 from logging import getLogger
 
 from ads import logger, set_auth
-from ads.aqua.client.client import AsyncClient, Client, HttpxOCIAuth
+from ads.aqua.client.client import (
+    AsyncClient,
+    Client,
+    HttpxOCIAuth,
+    get_async_httpx_client,
+    get_httpx_client,
+)
 from ads.aqua.common.utils import fetch_service_compartment
 from ads.config import OCI_RESOURCE_PRINCIPAL_VERSION
 

ads/aqua/client/client.py

@@ -794,3 +794,49 @@ async def embeddings(
         logger.debug(f"Generating embeddings with input: {input}, payload: {payload}")
         payload = {**(payload or {}), "input": input}
         return await self._request(payload=payload, headers=headers)
+
+
+def get_httpx_client(**kwargs: Any) -> httpx.Client:
+    """
+    Creates and returns a synchronous httpx Client configured with OCI authentication.
+
+    This function checks if an 'auth' keyword argument is provided. If not, it instantiates
+    the default OCI authentication (HttpxOCIAuth) and injects it into the client configuration.
+    Any additional keyword arguments are passed directly to the httpx.Client constructor.
+
+    Parameters
+    ----------
+    **kwargs : Any
+        Arbitrary keyword arguments for configuring the httpx.Client. An optional 'auth'
+        argument can be provided to override the default OCI authentication.
+
+    Returns
+    -------
+    Client
+        A configured synchronous httpx Client instance.
+    """
+    kwargs["auth"] = kwargs.get("auth") or HttpxOCIAuth()
+    return httpx.Client(**kwargs)
+
+
+def get_async_httpx_client(**kwargs: Any) -> httpx.AsyncClient:
+    """
+    Creates and returns an asynchronous httpx AsyncClient configured with OCI authentication.
+
+    This function checks if an 'auth' keyword argument is provided. If not, it instantiates
+    the default OCI authentication (HttpxOCIAuth) and injects it into the client configuration.
+    Any additional keyword arguments are passed directly to the httpx.AsyncClient constructor.
+
+    Parameters
+    ----------
+    **kwargs : Any
+        Arbitrary keyword arguments for configuring the httpx.AsyncClient. An optional 'auth'
+        argument can be provided to override the default OCI authentication.
+
+    Returns
+    -------
+    AsyncClient
+        A configured asynchronous httpx AsyncClient instance.
+    """
+    kwargs["auth"] = kwargs.get("auth") or HttpxOCIAuth()
+    return httpx.AsyncClient(**kwargs)

docs/source/user_guide/large_language_model/aqua_client.rst

@@ -147,13 +147,11 @@ Usage
 **Synchronous HTTPX Client**
 
 .. code-block:: python3
-
-    import httpx
     import ads
-    from ads.aqua import HttpxOCIAuth
 
     ads.set_auth(auth="security_token", profile="<replace-with-your-profile>")
-    client = httpx.Client(auth=HttpxOCIAuth())
+
+    client = ads.aqua.get_httpx_client()
 
     response = client.post(
         url="https://<MD_OCID>/predict",
@@ -170,9 +168,8 @@ Usage
 
 .. code-block:: python3
 
-    import httpx
     import ads
-    from ads.aqua import HttpxOCIAuth
 
     ads.set_auth(auth="security_token", profile="<replace-with-your-profile>")
-    async_client = httpx.AsyncClient(auth=HttpxOCIAuth())
+
+    async_client = client = ads.aqua.get_async_httpx_client()