?hdZddlZddlZddlmZmZmZmZm Z m Z m Z m Z ddl mZddlmZddlmZddlmZddlmZmZdd lmZmZdd lmZdd lmZm Z m!Z!m"Z"m#Z#Gd d Z$deee%de&de'fdZ(y)z DataObject class definition. N)AnyDictListOptionalSequenceTupleUnioncast)ConnectionError) Connection) Reference)ConsistencyLevel)!DATA_DEPRECATION_NEW_V14_CLS_NS_W!DATA_DEPRECATION_OLD_V14_CLS_NS_W)ObjectAlreadyExistsExceptionUnexpectedStatusCodeException)UUID)_get_dict_from_object get_vectorget_valid_uuid_capitalize_first_letter_check_positive_numc eZdZdZdefdZ ddeeefdedeee jdfde e d e e d e ed efd Z ddeeefdedeee jfde e d e e d e ed dfd Z ddeeefdedeee jfde e d e e d e ed dfdZ ddeeefdedeee jfde e d eeeefeff dZ ddeee jfde eedede ede ed e e d e ed e efdZ d deee jdfde eedede ede ed e e de ede e de ede eeeeeeeeeffd e ed e eeeffdZ ddeee jfde ed e e d e ed df dZ ddeee jfde ed e e d e ed ef dZ d!deeefdedeee jdfde e d ef dZy)" DataObjectz DataObject class used to manipulate object to/from Weaviate. Attributes ---------- reference : weaviate.data.references.Reference A Reference object to create objects cross-references. connectioncF||_t|j|_y)z Initialize a DataObject class instance. Parameters ---------- connection : weaviate.connect.Connection Connection object to an active and running Weaviate instance. N) _connectionr reference)selfrs U/home/chris/cleankitchens-env/lib/python3.12/site-packages/weaviate/data/crud_data.py__init__zDataObject.__init__&s&"4#3#34N data_object class_nameuuidvectorconsistency_leveltenantreturnc|t|tstdt|t |}t ||d}|t ||d<|t||d<d} i} |t|j| d<|||d< |jj| || } | jd k(rt| jdSd } d | jdddvrd} | rt!t|t#d| #t$r} td | d} ~ wwxYw#t$rYJwxYw)a Takes a dict describing the object and adds it to Weaviate. Parameters ---------- data_object : dict or str Object to be added. If type is str it should be either a URL or a file. class_name : str Class name associated with the object given. uuid : str, uuid.UUID or None, optional Object will be created under this uuid if it is provided. Otherwise, Weaviate will generate a uuid for this object, by default None. vector: Sequence or None, optional Embedding for the object. Can be used when: - a class does not have a vectorization module. - The given vector was generated using the _identical_ vectorization module that is configured for the class. In this case this vector takes precedence. Supported types are `list`, 'numpy.ndarray`, `torch.Tensor` and `tf.Tensor`, by default None. consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge tenant: Optional[str], optional The name of the tenant for which this operation is being performed. Examples -------- Schema contains a class Author with only 'name' and 'age' primitive property. >>> client.data_object.create( ... data_object = {'name': 'Neil Gaiman', 'age': 60}, ... class_name = 'Author', ... ) '46091506-e3a0-41a4-9597-10e3064d8e2d' >>> client.data_object.create( ... data_object = {'name': 'Andrzej Sapkowski', 'age': 72}, ... class_name = 'Author', ... uuid = 'e067f671-1202-42c6-848b-ff4d1eb804ab' ... ) 'e067f671-1202-42c6-848b-ff4d1eb804ab' Returns ------- str Returns the UUID of the created object if successful. Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. weaviate.ObjectAlreadyExistsException If an object with the given uuid already exists within Weaviate. weaviate.UnexpectedStatusCodeException If creating the object in Weaviate failed for a different reason, more information is given in the exception. requests.ConnectionError If the network connection to Weaviate fails. z)Expected class_name of type str but was: class propertiesNidr&/objectsr'r(pathweaviate_objectparamsz!Object was not added to Weaviate.Fzalready existserrorrmessageTzCreating object) isinstancestr TypeErrortyperrrrrvaluerpostRequestsConnectionError status_codejsonKeyErrorrr)rr#r$r%r&r'r(loaded_data_object weaviate_objr1r3responseconn_errobject_does_already_exists r createzDataObject.create3szR*c*GZHXGYZ[ [2;?.j9,   !/!5L   %/%7L "  (*:;L*M*S*SF& '  %+L " ]'',,$ ]c,dH   3 &x}}t,- -$)! 8==?7#;A#>y#II,0) %.s4y9 9+,=xHH' ])*MNT\ \ ]   s*DD/ D, D''D,/ D;:D;c&i}|t|j|d<|j||||\}} |||d< |jj | ||} | j dk(rytd| #t $r} t d| d} ~ wwxYw)a Update an already existing object in Weaviate with the given data object. Overwrites only the specified fields, the unspecified ones remain unchanged. Parameters ---------- data_object : dict or str The object states the fields that should be updated. Fields not specified in the 'data_object' remain unchanged. Fields that are None will not be changed. If type is str it should be either an URL or a file. class_name : str The class name of the object. uuid : str or uuid.UUID The ID of the object that should be changed. vector: Sequence or None, optional Embedding for the object. Can be used when: - a class does not have a vectorization module. - The given vector was generated using the _identical_ vectorization module that is configured for the class. In this case this vector takes precedence. Supported types are `list`, 'numpy.ndarray`, `torch.Tensor` and `tf.Tensor`, by default None. consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge tenant: Optional[str], optional The name of the tenant for which this operation is being performed. Examples -------- >>> author_id = client.data_object.create( ... data_object = {'name': 'Philip Pullman', 'age': 64}, ... class_name = 'Author' ... ) >>> client.data_object.get(author_id) { "additional": {}, "class": "Author", "creationTimeUnix": 1617111215172, "id": "bec2bca7-264f-452a-a5bb-427eb4add068", "lastUpdateTimeUnix": 1617111215172, "properties": { "age": 64, "name": "Philip Pullman" }, "vectorWeights": null } >>> client.data_object.update( ... data_object = {'age': 74}, ... class_name = 'Author', ... uuid = author_id ... ) >>> client.data_object.get(author_id) { "additional": {}, "class": "Author", "creationTimeUnix": 1617111215172, "id": "bec2bca7-264f-452a-a5bb-427eb4add068", "lastUpdateTimeUnix": 1617111215172, "properties": { "age": 74, "name": "Philip Pullman" }, "vectorWeights": null } Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none successful status. Nr'r(r0zObject was not updated.z#Update of the object not successful)rr;_create_object_for_updaterpatchr=r>r rr#r$r%r&r'r(r3rBr1rCrDs r updatezDataObject.updatesn  (*:;L*M*S*SF& '!;;KUY[ab d  %+L " S''-- ,.H   3 & +,QS[\\ ' S)*CD( R SA66 B? B  Bc&i}|t|j|d<|j||||\}} |||d< |jj | ||} | j dk(rytd| #t $r} t d| d} ~ wwxYw)a Replace an already existing object with the given data object. This method replaces the whole object. Parameters ---------- data_object : dict or str Describes the new values. It may be an URL or path to a json or a python dict describing the new values. class_name : str Name of the class of the object that should be updated. uuid : str or uuid.UUID The UUID of the object that should be changed. vector: Sequence or None, optional Embedding for the object. Can be used when: - a class does not have a vectorization module. - The given vector was generated using the _identical_ vectorization module that is configured for the class. In this case this vector takes precedence. Supported types are `list`, 'numpy.ndarray`, `torch.Tensor` and `tf.Tensor`, by default None. consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge tenant: Optional[str], optional The name of the tenant for which this operation is being performed. Examples -------- >>> author_id = client.data_object.create( ... data_object = {'name': 'H. Lovecraft', 'age': 46}, ... class_name = 'Author' ... ) >>> client.data_object.get(author_id) { "additional": {}, "class": "Author", "creationTimeUnix": 1617112817487, "id": "d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", "lastUpdateTimeUnix": 1617112817487, "properties": { "age": 46, "name": "H. Lovecraft" }, "vectorWeights": null } >>> client.data_object.replace( ... data_object = {'name': 'H.P. Lovecraft'}, ... class_name = 'Author', ... uuid = author_id ... ) >>> client.data_object.get(author_id) { "additional": {}, "class": "Author", "id": "d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", "lastUpdateTimeUnix": 1617112838668, "properties": { "name": "H.P. Lovecraft" }, "vectorWeights": null } Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none OK status. Nr'r(r0zObject was not replaced.r4zReplace object)rr;rIrputr=r>rrKs r replacezDataObject.replace sf  (*:;L*M*S*SF& '!;;KUY[ab d  %+L " T''++|\b+cH   3 & +,>&H 7 CDAdVLDT!!tf%DT!!r"additional_properties with_vector node_namec 2|j|||||||S)a Get an object as dict. Parameters ---------- uuid : str or uuid.UUID The identifier of the object that should be retrieved. additional_properties : list of str, optional List of additional properties that should be included in the request, by default None with_vector: bool If True the `vector` property will be returned too, by default False. class_name : Optional[str], optional The class name of the object with UUID `uuid`. Introduced in Weaviate version v1.14.0. STRONGLY recommended to set it with Weaviate >= 1.14.0. It will be required in future versions of Weaviate Server and Clients. Use None value ONLY for Weaviate < v1.14.0, by default None tenant: str, optional The name of the tenant for which this operation is being performed. Examples -------- >>> client.data_object.get_by_id( ... uuid="d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617112817487, "id": "d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", "lastUpdateTimeUnix": 1617112817487, "properties": { "age": 46, "name": "H.P. Lovecraft" }, "vectorWeights": null } Returns ------- dict or None dict in case the object exists. None in case the object does not exist. Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none OK status. )r%rXrYr$rZr'r()get)rr%rXrYr$rZr'r(s r get_by_idzDataObject.get_by_ids0Hxx"7#!/  r"limitafteroffsetsortc P|jjdk\} |$| r"| tjtt d|K|I| s tjt t dt|tstdt|t||} |r$| r"|dt|}nd}t|| d<nd}||d t|zz }|t|j| d <| | | d <||| d <|t!|d t"d|| d <|t|| d<| t!| dt"d| | d<| d| vr t%dd| vrd| d<t| t&stdt| dt| dtr | dg| d<nCt| dt(rt+d| dDstdt| ddt-| ddk(r t%dt| dt.r| dgt-| dz| d<nCt| dt(rt+d| dDstdt| ddt-| dt-| dk7r*t%dt-| ddt-| ddt-| ddk(r t%d d!j1| d| d"<| dDcgc]}|rd#nd$ }}d!j1|| d%< |jj3|| &}|j6d(k(r+t9t&tt:f|j=S|j6d)k(ryt?d*|cc}w#t4$r}t5d'|d}~wwxYw)+aP Gets objects from Weaviate, the maximum number of objects returned is 100. If 'uuid' is None, all objects are returned. If 'uuid' is specified the result is the same as for `get_by_uuid` method. Parameters ---------- uuid : str, uuid.UUID or None, optional The identifier of the object that should be retrieved. additional_properties : list of str, optional list of additional properties that should be included in the request, by default None with_vector : bool If True the `vector` property will be returned too, by default False class_name: Optional[str], optional The class name of the object with UUID `uuid`. Introduced in Weaviate version v1.14.0. STRONGLY recommended to set it with Weaviate >= 1.14.0. It will be required in future versions of Weaviate Server and Clients. Use None value ONLY for Weaviate < v1.14.0, by default None consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge a request before it is considered successful. Mutually exclusive with node_name param. node_name : Optional[str], optional The name of the target node which should fulfill the request. Mutually exclusive with consistency_level param. limit: Optional[int], optional The maximum number of data objects to return. by default None, which uses the Weaviate default of 100 entries after: Optional[UUID], optional Can be used to extract all elements by giving the last ID from the previous "page". Requires limit to be set but cannot be combined with any other filters or search. Part of the Cursor API. offset: Optional[int], optional The offset of objects returned, i.e. the starting index of the returned objects. Should be used in conjunction with the 'limit' parameter. sort: Optional[Dict] A dictionary for sorting objects. sort['properties']: str, List[str] By which properties the returned objects should be sorted. When more than one property is given, the objects are sorted in order of the list. The order of the sorting can be given by using 'sort['order_asc']'. sort['order_asc']: bool, List[bool] The order the properties given in 'sort['properties']' should be returned in. When a single boolean is used, all properties are sorted in the same order. If a list is used, it needs to have the same length as 'sort'. Each properties order is then decided individually. If 'sort['order_asc']' is True, the properties are sorted in ascending order. If it is False, they are sorted in descending order. if 'sort['order_asc']' is not given, all properties are sorted in ascending order. tenant: Optional[str], optional The name of the tenant for which this operation is being performed. Returns ------- list of dicts A list of all objects. If no objects where found the list is empty. Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none OK status. rRNr6category stacklevel.'class_name' must be of type str. Given type: rSr/r,rTr'r(rZr^F) include_zeror_r`Tr-zz!DataObject.get..fsE'( 1c"EzC'sort['properties']' must be of type str or list[str]. Given type: rz-'sort['properties']' cannot be an empty list.c3<K|]}t|tywrl)r7boolrms r rpz!DataObject.get..qsD() 1d#DrqzG'sort['order_asc']' must be of type boolean or list[bool]. Given type: z'sort['order_asc']' must be the same length as 'sort['properties']' or a boolean (not in a list). Current length is sort['properties']:z and sort['order_asc']:z,'sort['order_asc']' cannot be an empty list.,raascdescorderr1r3zCould not get object/s.r4z Get object/s) rrUwarningswarnrDeprecationWarningrr7r8r9r: _get_paramsrrrr;rint ValueErrorrlistalllenrsjoinr\r=r>r rr?r)rr%rXrYr$rZr'r^r_r`rar(rWr3r1rorwrCrDs r r\zDataObject.getsy\ $//>>&H  "64;K MM9+   !d&6' =/  j#."PQUV`QaPb cdd2K@ ."#;J#G"HI!"::"FwD   C... .D  (*:;L*M*S*SF& '  %F8   "+F;    w% H#F7O  ,U3F7O   #D I%F8   4' !_``$&$([!dD)"KDQUJEB YZ^_cdp_qZrYsstu4 %&!+ !PQQ${+T2%)+%6$7#d<>P:Q$Q[![ 148D-1+->DA ]^bcghsct^u]vvwx4 %&#d;.?*@@ ^_bcghtcu_v^wwNORSWXcSdOeNffgh4 $%* !OPP XXd<&89F6N59+5FGaUV+GEG!hhuoF7O S''++,H   3 &S#X 8 8   3 &+NHEEH' S)*CD( R Ss/ NN N% N  N%cPt|}|jjdk\}|"|r tjt t d|I|s tjtt dt|tstdt||r|rdt|d|}nd|}i}|dt|ji}|||d < |jj|| }|j"d k(ryt%d |#t $r} t!d | d} ~ wwxYw)a[ Delete an existing object from Weaviate. Parameters ---------- uuid : str or uuid.UUID The ID of the object that should be deleted. class_name : Optional[str], optional The class name of the object with UUID `uuid`. Introduced in Weaviate version v1.14.0. STRONGLY recommended to set it with Weaviate >= 1.14.0. It will be required in future versions of Weaviate Server and Clients. Use None value ONLY for Weaviate < v1.14.0, by default None consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge tenant: str, optional The name of the tenant for which this operation is being performed. Examples -------- >>> client.data_object.get( ... uuid="d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617112817487, "id": "d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", "lastUpdateTimeUnix": 1617112817487, "properties": { "age": 46, "name": "H.P. Lovecraft" }, "vectorWeights": null } >>> client.data_object.delete( ... uuid="d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) >>> client.data_object.get( ... uuid="d842a0f4-ad8c-40eb-80b4-bfefc7b1b530", ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) None Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none OK status. TypeError If parameter has the wrong type. ValueError If uuid is not properly formed. rRNrcrdrgrSrTr'r(rxzObject could not be deleted.rHz Delete object)rrrUrzr{rr|rr7r8r9r:rrr;deleter=r>r rr%r$r'r(rWr1r3rCrDs r rzDataObject.deletesQ@d##//>>&H  "6 MM9+   !' =/  j#."PQUV`QaPb cdd .7 CDAdVLDtf%D  ()+;= 1.14.0. It will be required in future versions of Weaviate Server and Clients. Use None value ONLY for Weaviate < 1.14.0, by default None consistency_level : Optional[ConsistencyLevel], optional Can be one of 'ALL', 'ONE', or 'QUORUM'. Determines how many replicas must acknowledge tenant: Optional[str], optional The name of the tenant for which this operation is being performed. Examples -------- >>> client.data_object.exists( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) False >>> client.data_object.create( ... data_object = {'name': 'Andrzej Sapkowski', 'age': 72}, ... class_name = 'Author', ... uuid = 'e067f671-1202-42c6-848b-ff4d1eb804ab' ... ) >>> client.data_object.exists( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) True Returns ------- bool True if object exists, False otherwise. Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a none OK status. TypeError If parameter has the wrong type. ValueError If uuid is not properly formed. rRNrcrdrgrSrTr'r(rxz Could not check if object exist.rHTryFz Object exists)rrUrzr{rr|rr7r8r9r:rrrr;headr=r>rrs r existszDataObject.existssfv $//>>&H  "6 MM9+   !' =/  j#."PQUV`QaPb cdd .7 CDAnUYFZE[\D~d345D  ()+;>> client1.data_object.validate( ... data_object = {'name': 'H. Lovecraft'}, ... class_name = 'Author' ... ) {'error': None, 'valid': True} >>> client1.data_object.validate( ... data_object = {'name': 'H. Lovecraft', 'age': 46}, ... class_name = 'Author' ... ) { "error": [ { "message": "invalid object: no such prop with name 'age' found in class 'Author' in the schema. Check your schema files for which properties in this class are available" } ], "valid": false } Returns ------- dict Validation result. E.g. {"valid": bool, "error": None or list} Raises ------ TypeError If argument is of wrong type. ValueError If argument contains an invalid value. weaviate.UnexpectedStatusCodeException If validating the object against Weaviate failed with a different reason. requests.ConnectionError If the network connection to Weaviate fails. z+Expected class_name of type `str` but was: r+Nr.r&z/objects/validate)r1r2z*Object was not validated against Weaviate.r5r4TvalidiFzValidate object)rr7r8r9r:rrrrr<r=r>r?r) rr#r$r%r&rArBr1rCrDresults r validatezDataObject.validate^s"N3;?*c*I$zJZI[\] ].j9,  !/!5L   %/%7L "" '',,$ ,UH     3 &"F7OM   3 &#F7O&mmog6F7OM+,=xHH' )<  s$C C- C((C-)NNNN)NNNrl)NFNNNN) NNFNNNNNNNN)NN)__name__ __module__ __qualname____doc__r r!r dictr8uuid_librrrrrFrLrPrrrrIrrsr]r~r\rrrr"r rrs 5: 5"15%)8< $lI49%lIlIC,- lI " lI $$45 lI lI lIf&*8< $i]49%i]i]C&' i] " i] $$45 i] i] i]`&*8< $`H49%`H`HC&' `H " `H $$45 `H `H `HN&* "49%""C&' " " " tCH~s" # "D6:!$(#'8< $L C&'L  (S 2L  L SM L C= L $$45L  L  $L `1559!$(#'8<# $ $MQ $rFC,-rF (S 2rF rF SM rF C= rF$$45rF}rF~rF rFtCsD$t*d3i'G!HHIJrF rF $sCx. !rFn%)8< $ hGC&'hGSMhG$$45 hG  hG  hGZ%)8< $ cGC&'cGSMcG$$45 cG  cG  cGR15%) gI49%gIgIC,- gI " gI  gIr"rrXrYr)ci}|r;t|tstdt|dj ||d<|rd|vr |ddz|d<|Sd|d<|S)a Get underscore properties in the format accepted by Weaviate. Parameters ---------- additional_properties : list of str or None A list of additional properties or None. with_vector: bool If True the `vector` property will be returned too. Returns ------- dict A dictionary including Weaviate-accepted additional properties and/or `vector` property. Raises ------ TypeError If 'additional_properties' is not of type list. z3Additional properties must be of type list but are rtincludez,vectorr&)r7rr9r:r)rXrYr3s r r}r}s.F/6 5679  HH%:;y   &y 1I =F9  M!)F9  Mr"))rr%rrztypingrrrrrrr r requests.exceptionsr r=weaviate.connectr weaviate.data.referencesr weaviate.data.replicationrweaviate.error_msgsrrweaviate.exceptionsrrweaviate.typesr weaviate.utilrrrrrrr8rsrr}rr"r rsqJJJJ'.6d iIiIX%xS ':%%RV%r"