?h-dZddlmZmZmZmZmZddlmZ ddl m Z ddl m Z ddlmZddlmZdd lmZdd lmZdd lmZmZdd lmZdd lmZddlmZmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)m*Z*eee'e'fe'fZ+GddZ,y)z Client class definition. )OptionalTupleUnionDictAny)ConnectionError)AuthCredentials)Backup)Batch)Classification)Cluster)Config) ConnectionTIMEOUT_TYPE_RETURN) Contextionary) DataObject) EmbeddedDBEmbeddedOptions)UnexpectedStatusCodeException)Query)Schema)NUMBERS)_get_valid_timeout_config_type_request_responsecJeZdZdZ ddeedeededee edfde dee d ee d ee d ee d dfd Zd e fdZd e fdZd e fdZd eeeeffdZed efdZej0ded dfdZedeed ee d eeeeffdZddZy)Clienta A python native Weaviate Client class that encapsulates Weaviate functionalities in one object. A Client instance creates all the needed objects to interact with Weaviate, and connects all of them to the same Weaviate instance. See below the Attributes of the Client instance. For the per attribute functionality see that attribute's documentation. Attributes ---------- backup : weaviate.backup.Backup A Backup object instance connected to the same Weaviate instance as the Client. batch : weaviate.batch.Batch A Batch object instance connected to the same Weaviate instance as the Client. classification : weaviate.classification.Classification A Classification object instance connected to the same Weaviate instance as the Client. cluster : weaviate.cluster.Cluster A Cluster object instance connected to the same Weaviate instance as the Client. contextionary : weaviate.contextionary.Contextionary A Contextionary object instance connected to the same Weaviate instance as the Client. data_object : weaviate.data.DataObject A DataObject object instance connected to the same Weaviate instance as the Client. schema : weaviate.schema.Schema A Schema object instance connected to the same Weaviate instance as the Client. query : weaviate.gql.Query A Query object instance connected to the same Weaviate instance as the Client. Nurlauth_client_secrettimeout_configproxies trust_envadditional_headersstartup_periodembedded_optionsadditional_configreturnc X| tn| } |j||\}} t||t|||||| | j| j  |_t|j |_t|j |_ t|j |_ t|j |_t|j |_t#|j |_t'|j |_t+|j |_y)ah Initialize a Client class instance. Parameters ---------- url : str The URL to the weaviate instance. auth_client_secret : weaviate.AuthCredentials or None, optional # fmt: off Authenticate to weaviate by using one of the given authentication modes: - weaviate.auth.AuthBearerToken to use existing access and (optionally, but recommended) refresh tokens - weaviate.auth.AuthClientPassword to use username and password for oidc Resource Owner Password flow - weaviate.auth.AuthClientCredentials to use a client secret for oidc client credential flow # fmt: on timeout_config : tuple(Real, Real) or Real, optional Set the timeout configuration for all requests to the Weaviate server. It can be a real number or, a tuple of two real numbers: (connect timeout, read timeout). If only one real number is passed then both connect and read timeout will be set to that value, by default (2, 20). proxies : dict, str or None, optional Proxies to be used for requests. Are used by both 'requests' and 'aiohttp'. Can be passed as a dict ('requests' format: https://docs.python-requests.org/en/stable/user/advanced/#proxies), str (HTTP/HTTPS protocols are going to use this proxy) or None. Default None. trust_env : bool, optional Whether to read proxies from the ENV variables: (HTTP_PROXY or http_proxy, HTTPS_PROXY or https_proxy). Default False. NOTE: 'proxies' has priority over 'trust_env', i.e. if 'proxies' is NOT None, 'trust_env' is ignored. additional_headers : dict or None Additional headers to include in the requests. Can be used to set OpenAI/HuggingFace keys. OpenAI/HuggingFace key looks like this: {"X-OpenAI-Api-Key": ""}, {"X-HuggingFace-Api-Key": ""} by default None startup_period : int or None How long the client will wait for Weaviate to start before raising a RequestsConnectionError. If None, the client won't wait at all. Default timeout is 5s. embedded_options : weaviate.embedded.EmbeddedOptions or None, optional Create an embedded Weaviate cluster inside the client - You can pass weaviate.embedded.EmbeddedOptions() with default values - Take a look at the attributes of weaviate.embedded.EmbeddedOptions to see what is configurable additional_config: weaviate.Config, optional Additional and advanced configuration options for weaviate. Examples -------- Without Auth. >>> client = Client( ... url = 'http://localhost:8080' ... ) >>> client = Client( ... url = 'http://localhost:8080', ... timeout_config = (5, 15) ... ) With Auth. >>> my_credentials = weaviate.AuthClientPassword(USER_NAME, MY_PASSWORD) >>> client = Client( ... url = 'http://localhost:8080', ... auth_client_secret = my_credentials ... ) Creating a client with an embedded database: >>> from weaviate import EmbeddedOptions >>> client = Client(embedded_options=EmbeddedOptions()) Creating a client with additional configurations: >>> from weaviate import Config >>> client = Client(additional_config=Config()) Raises ------ TypeError If arguments are of a wrong data type. N) rrr r!r"r#r$ embedded_db grcp_portconnection_config)r"_Client__parse_url_and_embedded_dbrrgrpc_port_experimentalr+ _connectionr classificationrschemar contextionaryr batchr data_objectrqueryr backuprcluster) selfrrr r!r"r#r$r%r&configr)s M/home/chris/cleankitchens-env/lib/python3.12/site-packages/weaviate/client.py__init__zClient.__init__6sz/6T--. *4+;+;<4++, %d&6&674++, T--. t//0 c| |jjd}|jdk(ryy#t$rYywxYw)z Ping Weaviate's ready state Returns ------- bool True if Weaviate is ready to accept requests, False otherwise. z/.well-known/readypathTF)r.get status_codeRequestsConnectionErrorr7responses r9is_readyzClient.is_readysG ''++1E+FH##s*&  s +/ ;;c\|jjd}|jdk(ryy)z Ping Weaviate's live state. Returns -------- bool True if weaviate is live and should not be killed, False otherwise. z/.well-known/liver=r?TF)r.r@rArCs r9is_livezClient.is_lives2##''-@'A   3 &r;c6|jjS)a* Get the meta endpoint description of weaviate. Returns ------- dict The dict describing the weaviate configuration. Raises ------ weaviate.UnexpectedStatusCodeException If weaviate reports a none OK status. )r.get_metar7s r9rIzClient.get_metas((**r;c|jjd}|jdk(rt|j S|jdk(ryt d|)a Get the openid-configuration. Returns ------- dict The configuration or None if not configured. Raises ------ weaviate.UnexpectedStatusCodeException If weaviate reports a none OK status. z!/.well-known/openid-configurationr=r?iNz Meta endpoint)r.r@rArjsonrrCs r9get_open_id_configurationz Client.get_open_id_configurations[##''-P'Q   3 &)(--/: :   3 &+OXFFr;c.|jjS)al Getter/setter for `timeout_config`. Parameters ---------- timeout_config : tuple(float, float) or float, optional For Getter only: Set the timeout configuration for all requests to the Weaviate server. It can be a real number or, a tuple of two real numbers: (connect timeout, read timeout). If only one real number is passed then both connect and read timeout will be set to that value. Returns ------- Tuple[float, float] For Getter only: Requests Timeout configuration. )r.r rJs r9r zClient.timeout_configs(...r;c8t||j_y)zW Setter for `timeout_config`. (docstring should be only in the Getter) N)rr.r )r7r s r9r zClient.timeout_config s +DN*S'r;c*| | td||td||7t|}|jd|jj|fSt |t stdt||jddfS)Nz/Either url or embedded options must be present.zFURL is not expected to be set when using embedded_options but URL was )optionszhttp://localhost:z$URL is expected to be string but is /) TypeErrorrstartrQport isinstancestrtypestrip)rr%r)s r9__parse_url_and_embedded_dbz"Client.__parse_url_and_embedded_dbs  # MN N  )coXY\X]^   '$-=>K    &{':':'?'?&@A;N N#s#B49+NO Oyy~t##r;cRt|dr|jjyy)Nr.)hasattrr.closerJs r9__del__zClient.__del__'s# 4 '    " " $ (r;) NN) <NFNNN)r'N)__name__ __module__ __qualname____doc__rrWr TIMEOUT_TYPErdictboolintrrr:rErGrIrrrMpropertyrr setter staticmethodrrr,r^r;r9rrs8"8<'/*.-1()6:.2s1 c]s1%_5s1% s1 tS$' s1  s1%TNs1! s1#?3s1$F+s1 s1j$& +$+"G8DcN+CG,/ 3//*T\TdTT$ c]$.6.G$ sHZ(( )$$&%r;rN)-retypingrrrrrrequests.exceptionsrrBauthr r5r r2r r/r r6rr8rconnect.connectionrrr1rdatarembeddedrr exceptionsrgqlrr0rtypesrutilrrrfrrmr;r9rxsg54J!*?(15CU7G+,g56 O%O%r;