?hidZddlZddlmZmZmZddlmZddl m Z ddl m Z ddl mZmZmZddlmZdd lmZmZGd d Zdd ed eedefdZdededdfdZy)z Reference class definition. N)UnionOptionalList)ConnectionError) Connection)ConsistencyLevel) REF_DEPRECATION_NEW_V14_CLS_NS_W%REF_DEPRECATION_OLD_V14_FROM_CLS_NS_W#REF_DEPRECATION_OLD_V14_TO_CLS_NS_W)UnexpectedStatusCodeException)get_valid_uuid_capitalize_first_letterceZdZdZdefdZ ddedededeed eed eed eed dfd Z ddedede e eefdeede e eedfd eed eed dfdZ ddedededeed eed eed eed dfdZ y) ReferencezG Reference class used to manipulate references within objects. connectionc||_y)z Initialize a Reference class instance. Parameters ---------- connection : weaviate.connect.Connection Connection object to an active and running weaviate instance. N) _connection)selfrs f/home/chris/cleankitchens-env/lib/python3.12/site-packages/weaviate/data/references/crud_references.py__init__zReference.__init__s &N from_uuidfrom_property_nameto_uuidfrom_class_name to_class_nameconsistency_leveltenantreturnc|jjdk\}i} |t|j| d<||| d<||"|r t j t td|/|s t j ttdt|d|/|s t j ttdt|d t|}t|}t|d |r|rt|t| } n t| } |r|rt|} d | d|d|} nd |d|} |jj| | | } | j dk(ryt#d| #t$r}td|d}~wwxYw)a Remove a reference to another object. Equal to removing one direction of an edge from the graph. Parameters ---------- from_uuid : str The ID of the object that references another object. from_property_name : str The property from which the reference should be deleted. to_uuid : str The UUID of the referenced object. from_class_name : Optional[str], optional The class name of the object for which to delete the reference (with UUID `from_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. 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 to_class_name : Optional[str], optional The referenced object class name to which to delete the reference (with UUID `to_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. 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: Optional[str], optional The name of the tenant for which this operation is being performed. Examples -------- Assume we have two classes, Author and Book. >>> # Create the objects first >>> client.data_object.create( ... data_object={'name': 'Ray Bradbury'}, ... class_name='Author', ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab' ... ) >>> client.data_object.create( ... data_object={'title': 'The Martian Chronicles'}, ... class_name='Book', ... uuid='a9c1b714-4f8a-4b01-a930-38b046d69d2d' ... ) >>> # Add the cross references >>> ## Author -> Book >>> client.data_object.reference.add( ... from_uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... from_property_name='wroteBooks', ... to_uuid='a9c1b714-4f8a-4b01-a930-38b046d69d2d', ... from_class_name='Author', # ONLY with Weaviate >= 1.14.0 ... to_class_name='Book', # ONLY with Weaviate >= 1.14.0 ... ) >>> client.data_object.get( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617177700595, "id": "e067f671-1202-42c6-848b-ff4d1eb804ab", "lastUpdateTimeUnix": 1617177700595, "properties": { "name": "Ray Bradbury", "wroteBooks": [ { "beacon": "weaviate://localhost/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d", "href": "/v1/objects/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d" } ] }, "vectorWeights": null } >>> # delete the reference >>> client.data_object.reference.delete( ... from_uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... from_property_name='wroteBooks', ... to_uuid='a9c1b714-4f8a-4b01-a930-38b046d69d2d', ... from_class_name='Author', # ONLY with Weaviate >= 1.14.0 ... to_class_name='Book', # ONLY with Weaviate >= 1.14.0 ... ) >>> >>> client.data_object.get( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617177700595, "id": "e067f671-1202-42c6-848b-ff4d1eb804ab", "lastUpdateTimeUnix": 1617177864970, "properties": { "name": "Ray Bradbury", "wroteBooks": [] }, "vectorWeights": null } 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. 1.14Nrrmessagecategory stacklevelrargument argument_namerrr class_namer /objects// /references/pathweaviate_objectparamszReference was not deleted.z#Delete property reference to object)rserver_versionrvaluewarningswarnr DeprecationWarningr _validate_string_argumentsr r _get_beaconrdeleteRequestsConnectionError status_coder rrrrrrrris_server_version_14r3beacon _class_namer1responseconn_errs rr<zReference.delete(sr $//>>&H  (*:;L*M*S*SF& '  %F8   #}'|D])} t| trtd t| t!|d k(rd}t|ts|g}t|tr|gt!|z}|"t!|t!|k7r t#d t%|}t|d g} |rI|rGt'||D]7\} } t%| } t)| t+| } | j-| 9n/|D]*} t%| } t)| } | j-| ,|r|rt+|}d|d|d|}nd|d|} |jj/|| | }|j2dk(ryt5d|#t0$r}t1d|d}~wwxYw)aX Allows to update all references in that property with a new set of references. All old references will be deleted. Parameters ---------- from_uuid : str The object that should have the reference as part of its properties. Should be in the form of an UUID or in form of an URL. E.g. 'http://localhost:8080/v1/objects/Book/fc7eb129-f138-457f-b727-1b29db191a67' or 'fc7eb129-f138-457f-b727-1b29db191a67' from_property_name : str The name of the property within the object. to_uuids : list or str The UUIDs of the objects that should be referenced. Should be a list of str in the form of an UUID or str in form of an URL. E.g. ['http://localhost:8080/v1/objects/Book/fc7eb129-f138-457f-b727-1b29db191a67', ...] or ['fc7eb129-f138-457f-b727-1b29db191a67', ...] If `str` it is converted internally into a list of str. from_class_name : Optional[str], optional The class name of the object for which to delete the reference (with UUID `from_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. 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 to_class_names : Union[list, str, None], optional The referenced objects class name to which to delete the reference (with UUID `to_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. It can be a single class name (assumes all `to_uuids` are of the same class) or a list of class names where for each UUID in `to_uuids` we have a class name. 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: Optional[str] The name of the tenant for which this operation is being performed. Examples -------- You have data object 1 with reference property `wroteBooks` and currently has one reference to data object 7. Now you say, I want to update the references of data object 1.wroteBooks to this list 3,4,9. After the update, the data object 1.wroteBooks is now 3,4,9, but no longer contains 7. >>> client.data_object.get( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab' ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617177700595, "id": "e067f671-1202-42c6-848b-ff4d1eb804ab", "lastUpdateTimeUnix": 1617177700595, "properties": { "name": "Ray Bradbury", "wroteBooks": [ { "beacon": "weaviate://localhost/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d", "href": "/v1/objects/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d" } ] }, "vectorWeights": null } Currently there is only one `Book` reference. Update all the references of the Author for property name `wroteBooks`. >>> client.data_object.reference.update( ... from_uuid = 'e067f671-1202-42c6-848b-ff4d1eb804ab', ... from_property_name = 'wroteBooks', ... to_uuids = [ ... '8429f68f-860a-49ea-a50b-1f8789515882', ... '3e2e6795-298b-47e9-a2cb-3d8a77a24d8a' ... ], ... from_class_name='Author', # ONLY with Weaviate >= 1.14.0 ... to_class_name='Book', # ONLY with Weaviate >= 1.14.0 ... ) >>> client.data_object.get( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab' ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617181292677, "id": "e067f671-1202-42c6-848b-ff4d1eb804ab", "lastUpdateTimeUnix": 1617181409405, "properties": { "name": "Ray Bradbury", "wroteBooks": [ { "beacon": "weaviate://localhost/Book/8429f68f-860a-49ea-a50b-1f8789515882", "href": "/v1/objects/Book/8429f68f-860a-49ea-a50b-1f8789515882" }, { "beacon": "weaviate://localhost/Book/3e2e6795-298b-47e9-a2cb-3d8a77a24d8a", "href": "/v1/objects/Book/3e2e6795-298b-47e9-a2cb-3d8a77a24d8a" } ] }, "vectorWeights": null } All the previous references were removed and now we have only those specified in the `update` method. Raises ------ requests.ConnectionError If the network connection to weaviate fails. weaviate.UnexpectedStatusCodeException If weaviate reports a none OK status. TypeError If the parameters are of the wrong type. ValueError If the parameters are of the wrong value. r!Nrrr"r#rr'rGzJ'to_class_names' must be of type str of List[str]. Found element of type: rzH'to_class_names' and 'to_uuids' have different lengths, they must match.rr*r,r-r.r/r0zReference was not updated.z#Update property reference to object)rr5rr6r7r8r r9r r:r isinstanceliststr TypeErrortypelen ValueErrorr zipr;rappendputr=r>r )rrrrFrrGrrr@r3rbeaconsrrArBr1rCrDs rupdatezReference.updatesH $//>>&H  (*:;L*M*S*SF& '  %F8   #~'=CW MM8+   &' A/  '(/   %' ?/  nd3*+"2 &4M%mS9'66:=6I5JL ~&!+%)N(D) zH nc *,-H =N  %#h-3~;N*NZ  #9- "'.  2*-h*G '&(1$#7 Fv&  '$ '(1$#v&  ' 32?CK{m1YK|DVCWXDyk6H5IJD V''++ ',H   3 & +,QS[\\ ' V)*FGX U Vs"I I6% I11I6c|jjdk\}i} |t|j| d<||| d<||"|r t j t td|/|s t j ttdt|d|/|s t j ttdt|d t|}t|}t|d |r|rt|t| } n t| } |r|rt|} d | d|d|} nd |d|} |jj| | | } | j dk(ryt#d| #t$r}td|d}~wwxYw)ah Allows to link an object to an object uni-directionally. Parameters ---------- from_uuid : str The ID of the object that should have the reference as part of its properties. Should be a plane UUID or an URL. E.g. 'http://localhost:8080/v1/objects/Book/fc7eb129-f138-457f-b727-1b29db191a67' or 'fc7eb129-f138-457f-b727-1b29db191a67' from_property_name : str The name of the property within the object. to_uuid : str The UUID of the object that should be referenced. Should be a plane UUID or an URL. E.g. 'http://localhost:8080/v1/objects/Book/fc7eb129-f138-457f-b727-1b29db191a67' or 'fc7eb129-f138-457f-b727-1b29db191a67' from_class_name : Optional[str], optional The class name of the object for which to delete the reference (with UUID `from_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. 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 to_class_name : Optional[str], optional The referenced object class name to which to delete the reference (with UUID `to_uuid`), it is included in Weaviate 1.14.0, where all objects are namespaced by class name. 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: Optional[str] The name of the tenant for which this operation is being performed. Examples -------- Assume we have two classes, Author and Book. >>> # Create the objects first >>> client.data_object.create( ... data_object={'name': 'Ray Bradbury'}, ... class_name='Author', ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab' ... ) >>> client.data_object.create( ... data_object={'title': 'The Martian Chronicles'}, ... class_name='Book', ... uuid='a9c1b714-4f8a-4b01-a930-38b046d69d2d' ... ) >>> # Add the cross references >>> ## Author -> Book >>> client.data_object.reference.add( ... from_uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... from_property_name='wroteBooks', ... to_uuid='a9c1b714-4f8a-4b01-a930-38b046d69d2d', ... from_class_name='Author', # ONLY with Weaviate >= 1.14.0 ... to_class_name='Book', # ONLY with Weaviate >= 1.14.0 ... ) >>> client.data_object.get( ... uuid='e067f671-1202-42c6-848b-ff4d1eb804ab', ... class_name='Author', # ONLY with Weaviate >= 1.14.0 ... ) { "additional": {}, "class": "Author", "creationTimeUnix": 1617177700595, "id": "e067f671-1202-42c6-848b-ff4d1eb804ab", "lastUpdateTimeUnix": 1617177700595, "properties": { "name": "Ray Bradbury", "wroteBooks": [ { "beacon": "weaviate://localhost/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d", "href": "/v1/objects/Book/a9c1b714-4f8a-4b01-a930-38b046d69d2d" } ] }, "vectorWeights": null } Raises ------ requests.ConnectionError If the network connection to weaviate fails. weaviate.UnexpectedStatusCodeException If weaviate reports a none OK status. TypeError If the parameters are of the wrong type. ValueError If the parameters are of the wrong value. r!Nrrr"r#rr'rrr*r,r-r.r/r0zReference was not added.rIz Add property reference to object)rr5rr6r7r8r r9r r:r r r;rpostr=r>r r?s raddz Reference.addsT $//>>&H  (*:;L*M*S*SF& '  %F8   #}'= 1.14.0. For Weaviate < 1.14.0 use None value. Returns ------- dict Weaviate-style beacon as a dict. rAzweaviate://localhost/r.r]r*s rr;r;~s6$1';<< -j\7)D EErr(r)cXt|tstd|dt|y)a Validate string arguments. Parameters ---------- argument : str Argument value to be validated. argument_name : str Argument name to be included in error message. Raises ------ TypeError If 'argument' is not of type str. 'z%' must be of type 'str'. Given type: N)rJrLrMrNr's rr:r:s4" h $!M?*OPTU]P^O_`aa %r)N)r\r7typingrrrrequests.exceptionsrr=weaviate.connectrweaviate.data.replicationrweaviate.error_msgsr r r weaviate.exceptionsr weaviate.utilr rrrLdictr;r:r]rrris((J'6 > d Zd ZNFF(3-F4F.bbSbTbr