Skip to content

Commit 1253865

Browse files
committed
Updates pydocs
1 parent e483687 commit 1253865

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

ads/aqua/client/client.py

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -798,17 +798,14 @@ async def embeddings(
798798

799799
def get_httpx_client(**kwargs: Any) -> httpx.Client:
800800
"""
801-
Creates and returns a synchronous httpx Client configured with OCI authentication.
802-
803-
This function checks if an 'auth' keyword argument is provided. If not, it instantiates
804-
the default OCI authentication (HttpxOCIAuth) and injects it into the client configuration.
805-
Any additional keyword arguments are passed directly to the httpx.Client constructor.
801+
Creates and returns a synchronous httpx Client configured with OCI authentication signer based
802+
the authentication type setup using ads.set_auth method or env variable OCI_IAM_TYPE.
803+
More information - https://accelerated-data-science.readthedocs.io/en/stable/user_guide/cli/authentication.html
806804
807805
Parameters
808806
----------
809807
**kwargs : Any
810-
Arbitrary keyword arguments for configuring the httpx.Client. An optional 'auth'
811-
argument can be provided to override the default OCI authentication.
808+
Keyword arguments supported by httpx.Client
812809
813810
Returns
814811
-------
@@ -821,17 +818,14 @@ def get_httpx_client(**kwargs: Any) -> httpx.Client:
821818

822819
def get_async_httpx_client(**kwargs: Any) -> httpx.AsyncClient:
823820
"""
824-
Creates and returns an asynchronous httpx AsyncClient configured with OCI authentication.
825-
826-
This function checks if an 'auth' keyword argument is provided. If not, it instantiates
827-
the default OCI authentication (HttpxOCIAuth) and injects it into the client configuration.
828-
Any additional keyword arguments are passed directly to the httpx.AsyncClient constructor.
821+
Creates and returns a synchronous httpx Client configured with OCI authentication signer based
822+
the authentication type setup using ads.set_auth method or env variable OCI_IAM_TYPE.
823+
More information - https://accelerated-data-science.readthedocs.io/en/stable/user_guide/cli/authentication.html
829824
830825
Parameters
831826
----------
832827
**kwargs : Any
833-
Arbitrary keyword arguments for configuring the httpx.AsyncClient. An optional 'auth'
834-
argument can be provided to override the default OCI authentication.
828+
Keyword arguments supported by httpx.Client
835829
836830
Returns
837831
-------

0 commit comments

Comments
 (0)