?hdZddlmZddlmZddlmZmZmZm Z m Z ddl m Z ddlmZddlmZddlmZdd lmZmZmZmZmZhd Zhd Zhd ZGd deeZeGddZGddZ de!de"fdZ#de!de!fdZ$de%de%de%fdZ&y)z Schema class definition. ) dataclass)Enum)UnionOptionalListDictcast)ConnectionError) Connection)UnexpectedStatusCodeException)Property)_get_dict_from_object_is_sub_schema_capitalize_first_letter_decode_json_response_dict_decode_json_response_list> class properties vectorizer description moduleConfigshardingConfigvectorIndexTypereplicationConfigvectorIndexConfigmultiTenancyConfiginvertedIndexConfig>namedataTyperr tokenization indexInvertedindexFilterableindexSearchable>int[]date[]text[]uuid[]number[]object[]string[] boolean[]intblobdatetextuuidnumberobjectstringboolean phoneNumbergeoCoordinatesceZdZdZdZdZy)TenantActivityStatusz TenantActivityStatus class used to describe the activity status of a tenant in Weaviate. Attributes ---------- HOT: The tenant is fully active and can be used. COLD: The tenant is not active, files stored locally. HOTCOLDN)__name__ __module__ __qualname____doc__r9r:Y/home/chris/cleankitchens-env/lib/python3.12/site-packages/weaviate/schema/crud_schema.pyr8r8Es C Dr@r8cxeZdZUdZeed<ejZeed<de eeffdZ e de eefddfdZ y) Tenantz Tenant class used to describe a tenant in Weaviate. Attributes ---------- activity_status : TenantActivityStatus, optional default: "HOT" name: the name of the tenant. ractivity_statusreturnc4|j|jdS)N)activityStatusr)rDr)selfs rA_to_weaviate_objectzTenant._to_weaviate_objectbs"22II  r@weaviate_objectc N||dt|jddS)NrrGr9)rrD)r8get)clsrJs rA_from_weaviate_objectzTenant._from_weaviate_objecths. (01D1DEUW\1]^  r@N) r;r<r=r>str__annotations__r8r9rDrrI classmethodrNr?r@rArCrCSs] I,@,D,DO)D T#s(^  DcN x  r@rCc eZdZdZdefdZdeeefddfdZ deeefddfd Z d eddfd Z d!d Z d ede fd Zd"deeeefde fdZd ededdfdZd"d eedefdZd edefdZ d"d ededeedefdZdeddfdZdeddfdZdeddfdZdeddfdZd edeeddfdZd edeeddfdZd edeefdZd edeeddfd Zy)#Schemaz Schema class used to interact and manipulate schemas or classes. Attributes ---------- property : weaviate.schema.properties.Property A Property object to create new schema property/ies. connectioncF||_t|j|_y)z Initialize a Schema class instance. Parameters ---------- connection : weaviate.connect.Connection Connection object to an active and running Weaviate instance. N) _connectionr property)rHrTs rA__init__zSchema.__init__zs& !1!12 r@schemarENcjt|}|j|d|j|dy)a Create the schema of the Weaviate instance, with all classes at once. Parameters ---------- schema : dict or str Schema as a Python dict, or the path to a JSON file, or the URL of a JSON file. Examples -------- >>> article_class = { ... "class": "Article", ... "description": "An article written by an Author", ... "properties": [ ... { ... "name": "title", ... "dataType": ["text"], ... "description": "The title the article", ... }, ... { ... "name": "hasAuthors", ... "dataType": ["Author"], ... "description": "Authors this article has", ... } ... ] ... } >>> author_class = { ... "class": "Author", ... "description": "An Author class to store the author information", ... "properties": [ ... { ... "name": "name", ... "dataType": ["text"], ... "description": "The name of the author", ... }, ... { ... "name": "wroteArticles", ... "dataType": ["Article"], ... "description": "The articles of the author", ... } ... ] ... } >>> client.schema.create({"classes": [article_class, author_class]}) If you have your schema saved in the './schema/my_schema.json' you can create it directly from the file. >>> client.schema.create('./schema/my_schema.json') Raises ------ TypeError If the 'schema' is neither a string nor a dict. ValueError If 'schema' can not be converted into a Weaviate schema. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. weaviate.SchemaValidationException If the 'schema' could not be validated against the standard format. classesN)r_create_classes_with_primitives'_create_complex_properties_from_classes)rHrY loaded_schemas rAcreatez Schema.creates5@.f5  ,,]9-EF 44]95MNr@ schema_classc^t|}|j||j|y)a Create a single class as part of the schema in Weaviate. Parameters ---------- schema_class : dict or str Class as a Python dict, or the path to a JSON file, or the URL of a JSON file. Examples -------- >>> author_class_schema = { ... "class": "Author", ... "description": "An Author class to store the author information", ... "properties": [ ... { ... "name": "name", ... "dataType": ["text"], ... "description": "The name of the author", ... }, ... { ... "name": "wroteArticles", ... "dataType": ["Article"], ... "description": "The articles of the author", ... } ... ] ... } >>> client.schema.create_class(author_class_schema) If you have your class schema saved in the './schema/my_schema.json' you can create it directly from the file. >>> client.schema.create_class('./schema/my_schema.json') Raises ------ TypeError If the 'schema_class' is neither a string nor a dict. ValueError If 'schema_class' can not be converted into a Weaviate schema. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. weaviate.SchemaValidationException If the 'schema_class' could not be validated against the standard format. N)r_create_class_with_primitives%_create_complex_properties_from_class)rHr`loaded_schema_classs rA create_classzSchema.create_classs.`4LA **+>? 223FGr@ class_namect|tstdt|ddt |} |j j |}|jdk7r td|y#t$r}td|d}~wwxYw) aI Delete a schema class from Weaviate. This deletes all associated data. Parameters ---------- class_name : str The class that should be deleted from Weaviate. Examples -------- >>> client.schema.delete_class('Author') Raises ------ TypeError If 'class_name' argument not of type str. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. zClass name was z instead of str/schema/pathzDeletion of class.NzDelete class from schema) isinstancerO TypeErrortyperrVdeleteRequestsConnectionError status_coder rHrfrjresponseconn_errs rA delete_classzSchema.delete_classs.*c*od:.>-?OP P2:>?@ N''..D.9H   3 &/0JHU U '' N)*>?X M NsA00 B 9 BB c~|j}|jdg}|D]}|j|dy)z Remove the entire schema from the Weaviate instance and all data associated with it. Examples -------- >>> client.schema.delete_all() r[rN)rLru)rHrYr[_classs rA delete_allzSchema.delete_all!s@**Y+ /F   fWo . /r@c:t|tstdt|ddt |} |j j |}|jdk(ry|jd k(ry td |#t$r}td|d}~wwxYw) a Check if class exists in Weaviate. Parameters ---------- class_name : str The class whose existence is being checked. Examples -------- >>> client.schema.exists(class_name="Exists") True >>> client.schema.exists(class_name="DoesNotExists") False Returns ------- bool True if the class exists, False otherwise. 9'class_name' argument must be of type `str`! Given type: .rhriz+Checking class existence could not be done.NrkTiFzCheck if class exists) rlrOrmrnrrVrLrprqr rrs rAexistsz Schema.exists/s0*c*KDQ[L\K]]^_ 2:>?@ ''+++6H   3 &  ! !S (+,CXNN' )=  sB B BBcz|j}|t|}t||St|ddk(ryy)a Check if Weaviate already contains a schema. Parameters ---------- schema : dict or str, optional Schema as a Python dict, or the path to a JSON file or the URL of a JSON file. If a schema is given it is checked if this specific schema is already loaded. It will test only this schema. If the given schema is a subset of the loaded schema it will still return true, by default None. Examples -------- >>> schema = client.schema.get() >>> client.schema.contains(schema) True >>> schema = client.schema.get() >>> schema['classes'].append( { "class": "Animal", "description": "An Animal", "properties": [ { "name": "type", "dataType": ["text"], "description": "The animal type", } ] } ) >>> client.schema.contains(schema) False Returns ------- bool True if a schema is present, False otherwise. r[rFT)rLrrlen)rHrYr^ sub_schemas rAcontainszSchema.contains[sER  .v6J!*m< < }Y' (A -r@configc t|}|j|}t||}d|z} |jj ||}|j dk7r td|y#t $r}t d|d}~wwxYw)a Update a schema configuration for a specific class. Parameters ---------- class_name : str The class for which to update the schema configuration. config : dict The configurations to update (MUST follow schema format). Example ------- In the example below we have a Weaviate instance with a class 'Test'. >>> client.schema.get('Test') { 'class': 'Test', ... 'vectorIndexConfig': { 'ef': -1, ... }, ... } >>> client.schema.update_config( ... class_name='Test', ... config={ ... 'vectorIndexConfig': { ... 'ef': 100, ... } ... } ... ) >>> client.schema.get('Test') { 'class': 'Test', ... 'vectorIndexConfig': { 'ef': 100, ... }, ... } NOTE: When updating schema configuration, the 'config' MUST be sub-set of the schema, starting at the top level. In the example above we update 'ef' value, and for this we included the 'vectorIndexConfig' top level too. Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rhrjrJz0Class schema configuration could not be updated.Nrkz!Update class schema configuration)rrL_update_nested_dictrVputrprqr )rHrfr class_schemanew_class_schemarjrsrts rA update_configzSchema.update_configsp.j9 xx + .|VDJ& ''++GW+XH   3 &/0SU]^ ^ ' ' )B  sA(( B1 A==Bc d}|5t|tstdt|dt |} |j j |}t|d}|J|S#t$r}td|d}~wwxYw)ao Get the schema from Weaviate. Parameters ---------- class_name : str, optional The class for which to return the schema. If NOT provided the whole schema is returned, otherwise only the schema of this class is returned. By default None. Returns ------- dict A dict containing the schema. The schema may be empty. To see if a schema has already been loaded, use the `contains` method. Examples -------- No schema present in client >>> client.schema.get() {'classes': []} Schema present in client >>> client.schema.get() { "classes": [ { "class": "Animal", "description": "An Animal", "invertedIndexConfig": { "cleanupIntervalSeconds": 60 }, "properties": [ { "dataType": ["text"], "description": "The animal type", "name": "type" } ], "vectorIndexConfig": { "cleanupIntervalSeconds": 300, "maxConnections": 64, "efConstruction": 128, "vectorCacheMaxObjects": 500000 }, "vectorIndexType": "hnsw", "vectorizer": "text2vec-contextionary", "replicationConfig": { "factor": 1 } } ] } >>> client.schema.get('Animal') { "class": "Animal", "description": "An Animal", "invertedIndexConfig": { "cleanupIntervalSeconds": 60 }, "properties": [ { "dataType": ["text"], "description": "The animal type", "name": "type" } ], "vectorIndexConfig": { "cleanupIntervalSeconds": 300, "maxConnections": 64, "efConstruction": 128, "vectorCacheMaxObjects": 500000 }, "vectorIndexType": "hnsw", "vectorizer": "text2vec-contextionary", "replicationConfig": { "factor": 1 } } Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. /schemaNrzrhrizSchema could not be retrieved.z Get schema) rlrOrmrnrrVrLrprrHrfrjrsrtress rArLz Schema.getsv  !j#.##' #3"466zBCDD Z''+++6H)<@ ' Z)*JKQY Y ZsA)) B2 A>>Bct|tstdt|ddt |d} |j j |}t|d}|J|S#t$r}td|d}~wwxYw) a Get the status of all shards in an index. Parameters ---------- class_name : str The class for which to return the status of all shards in an index. Returns ------- list The list of shards configuration. Examples -------- Schema contains a single class: Article >>> client.schema.get_class_shards('Article') [{'name': '2rPgsA2yngW3', 'status': 'READY'}] Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rzr{rhz/shardsrizDClass shards' status could not be retrieved due to connection error.NzGet shards' status) rlrOrmrnrrVrLrprrs rAget_class_shardszSchema.get_class_shardsAs:*c*NtT^O_N``ab 2:>?wG ''+++6H )3GH ' )V  sA'' B0 A<<Bstatus shard_namec zt|tstdt|dt|ts|tdt|dt|tstdt|d|%|j |}|Dcgc]}|d }}n|g}d|i}g}|D]P} d t |d | } |j j| | } |jt| d| dR||Stt|dScc}w#t$r} td | d | d} ~ wwxYw)au Get the status of all shards in an index. Parameters ---------- class_name : str The class for which to update the status of all shards in an index. status : str The new status of the shard. The available options are: 'READY' and 'READONLY'. shard_name : str or None, optional The shard name for which to update the status of the class of the shard. If None then all the shards are going to be updated to the 'status'. By default None. Returns ------- list The updated statuses. Examples -------- Schema contains a single class: Article >>> client.schema.get_class_shards('Article') [{'name': 'node1', 'status': 'READY'}, {'name': 'node2', 'status': 'READY'}] For a specific shard: >>> client.schema.update_class_shard('Article', 'READONLY', 'node2') {'status': 'READONLY'} >>> client.schema.get_class_shards('Article') [{'name': 'node1', 'status': 'READY'}, {'name': 'node2', 'status': 'READONLY'}] For all shards of the class: >>> client.schema.update_class_shard('Article', 'READONLY') [{'status': 'READONLY'},{'status': 'READONLY'}] >>> client.schema.get_class_shards('Article') [{'name': 'node1', 'status': 'READONLY'}, {'name': 'node2', 'status': 'READONLY'}] Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rzr{Nz9'shard_name' argument must be of type `str`! Given type: z5'status' argument must be of type `str`! Given type: )rfrrrhz/shards/rz5Class shards' status could not be updated for shard 'z' due to connection error.zUpdate shard 'z' statusr) rlrOrmrnrrrVrrpappendrr list) rHrfrr shards_config shard_config shard_namesdata to_return _shard_namerjrsrts rAupdate_class_shardzSchema.update_class_shardosl*c*NtT^O_N``ab *c*z/ENtT^O_N``ab &#&J4PV<.XYZ    11%2MERRL</RKR%,K&! & K6zBC8K=YD ++//$(0   *8~k]RZ5[\  "   D)A,''7S+ -KK=Y((   s DD D:%D55D:cd|vry|dD]}t|dr|dDcgc] }t|c}|dd}tddhz D]}||vs||||<dt|dzdz} |jj || }|j d k7std |ycc}w#t $r}t d |d}~wwxYw) a Add cross-references to an already existing class. Parameters ---------- schema_class : dict Description of the class that should be added. Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rNrr)rrrhrz /propertiesrz,Property may not have been created properly.rkzAdd properties to classes)_property_is_primitiver PROPERTY_KEYSrVpostrprqr ) rHr` property_dtypeschema_propertyproperty_fieldrjrsrts rArcz,Schema._create_complex_properties_from_classs" | + %l3 [I%i &;<KTT^J_`5e<`!&)O #06:2F"F P!Y.6?6OON3 P 8g9N OOR__D ++00dO0\ ##s*34OQYZZ- [ a+ -B  sB,1B11 C : CC schema_classes_listc4|D]}|j|y)z Add cross-references to already existing classes. Parameters ---------- schema_classes_list : list A list of classes as they are found in a schema JSON description. N)rc)rHrr`s rAr]z.Schema._create_complex_properties_from_classess#0 EL  6 6| D Er@weaviate_classc6t|dgd}tddhz D]}||vs||||<d|vrt|d|d< |jj d|}|j dk7r td |y#t $r}t d|d}~wwxYw) a Create class with only primitives. Parameters ---------- weaviate_class : dict A single Weaviate formatted class Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. r)rrrrrz)Class may not have been created properly.Nrkz Create class)r CLASS_KEYS_get_primitive_propertiesrVrrprqr )rHrr` class_fieldrsrts rArbz$Schema._create_class_with_primitives s&.nW.EF &,(?? HKn,,:;,G [) H > ))B>R^C_)`L & e'',,)\,ZH   3 &/I I '' e)*UV\d d esA>> B BBc4|D]}|j|y)aV Create all the classes in the list and primitive properties. This function does not create references, to avoid references to classes that do not yet exist. Parameters ---------- schema_classes_list : list A list of classes as they are found in a schema JSON description. N)rb)rHrrs rAr\z&Schema._create_classes_with_primitives2s!2 ?N  . .~ > ?r@tenantsc|Dcgc]}|j}}dt|d} |jj||}|j dk7r t d|ycc}w#t$r}t d|d}~wwxYw)a Add class's tenants in Weaviate. Parameters ---------- class_name : str The class for which we add tenants. tenants : List[Tenant] List of Tenants. Examples -------- >>> tenants = [ Tenant(name="Tenant1"), Tenant(name="Tenant2") ] >>> client.schema.add_class_tenants("class_name", tenants) Raises ------ TypeError If 'tenants' has not the correct type. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rh/tenantsrz1Classes tenants may not have been added properly.NrkzAdd classes tenants)rIrrVrrprqr )rHrfrtenantloaded_tenantsrjrsrts rAadd_class_tenantszSchema.add_class_tenantsAs4FMM6&446MM2:>?xH '',,$,WH   3 &/0ExP P 'N ' )C  sA'A,, B5 BBcdt|d} |jj||}|jdk7r t d|y#t$r}td|d}~wwxYw)a Remove class's tenants in Weaviate. Parameters ---------- class_name : str The class for which we remove tenants. tenants : List[str] List of tenant names to remove from the given class. Examples -------- >>> client.schema.remove_class_tenants("class_name", ["Tenant1", "Tenant2"]) Raises ------ TypeError If 'tenants' has not the correct type. requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rhrrz*Classes tenants may not have been deleted.NrkzDelete classes tenants)rrVrorprqr )rHrfrrjrsrts rAremove_class_tenantszSchema.remove_class_tenantsgs02:>?xH ''..D'.RH   3 &/0H(S S ' ' )<  sA A$ AA$cdt|d} |jj|}t |d}|J|Dcgc]}t j |c}S#t$r}td|d}~wwxYwcc}w)aGet class's tenants in Weaviate. Parameters ---------- class_name : str The class for which we get tenants. Examples -------- >>> client.schema.get_class_tenants("class_name") Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rhrrizCould not get class tenants.NzGet class tenants)rrVrLrprrCrN)rHrfrjrsrt tenant_resprs rAget_class_tenantszSchema.get_class_tenantss&2:>?xH X''+++6H1;NO &&&CNO,,V4OO ' X)*HIx W X PsA A= A:) A55A:cdt|d}|Dcgc]}|j}} |jj||}|j dk7r t d|ycc}w#t$r}t d|d}~wwxYw)aUpdate class tenants. Use this when you want to move tenants from one activity state to another. Parameters ---------- class_name : str The class for which we update tenants. tenants : List[Tenant] List of Tenants. Examples -------- >>> client.schema.add_class_tenants( "class_name", [ Tenant(activity_status=TenantActivityStatus.HOT, name="Tenant1")), Tenant(activity_status=TenantActivityStatus.COLD, name="Tenant2")) Tenant(name="Tenant3") ] ) >>> client.schema.update_class_tenants( "class_name", [ Tenant(activity_status=TenantActivityStatus.COLD, name="Tenant1")), Tenant(activity_status=TenantActivityStatus.HOT, name="Tenant2")) ] ) >>> client.schema.get_class_tenants("class_name") [ Tenant(activity_status=TenantActivityStatus.COLD, name="Tenant1")), Tenant(activity_status=TenantActivityStatus.HOT, name="Tenant2")), Tenant(activity_status=TenantActivityStatus.HOT, name="Tenant3")) ] Raises ------ requests.ConnectionError If the network connection to Weaviate fails. weaviate.UnexpectedStatusCodeException If Weaviate reports a non-OK status. rhrrzCould not update class tenants.NrkzUpdate classes tenants)rrIrVrrprqr )rHrfrrjrrrsrts rAupdate_class_tenantszSchema.update_class_tenantssX2:>?xHELM6&446MM [''++~+VH   3 &/0H(S S ' N' [)*KLRZ Z [sA'A,, B5 BB)rEN)N) r;r<r=r>r rXrdictrOr_rerurxboolr|rrrrLrrrrcr]rbr\rrCrrrrr?r@rArSrSps 3: 3BOU49-BO$BOH2HtSy)92Hd2Hh Vs Vt VD /*O*O*OX1xdCi(891T1fD_D_TD_dD_LkhsmktkZ,3,4,d%) b(b(b(SM b(  b(H*[$*[4*[X E4 ETX E$JD$JT$JL ?4 ?D ?$QC$Q$v,$Q4$QL Ts TT#Y T4 TDPCPDLP:3Ts3TT&\3Td3Tr@rSdata_type_listrEcBtt|tz dk(ryy)a Check if the property is primitive. Parameters ---------- data_type_list : list Data types to be checked if are primitive. Returns ------- bool True if it only consists of primitive data types, False otherwise. rTF)r~set_PRIMITIVE_WEAVIATE_TYPES_SET)rs rArrs"  3~ !> >?1D r@properties_listcXg}|D]"}t|ds|j|$|S)a Filter the list of properties for only primitive properties. Parameters ---------- properties_list : list A list of properties to extract the primitive properties. Returns ------- list A list of properties containing only primitives. r)rr)rprimitive_propertiesrs rArrs?$/ %i &;< ##I. / r@dict_1dict_2c|jD]B\}}||vr|||<t|trt|||0|j ||iD|S)a Update `dict_1` with elements from `dict_2` in a nested manner. If a value of a key is a dict, it is going to be updated and not replaced by the whole dict. Parameters ---------- dict_1 : dict The dictionary to be updated. dict_2 : dict The dictionary that contains values to be updated. Returns ------- dict The updated `dict_1`. )itemsrlrrupdate)rrkeyvalues rArr s`"lln( U f F3K  eT " s U 3 MM3, '( Mr@N)'r> dataclassesrenumrtypingrrrrr requests.exceptionsr rpweaviate.connectr weaviate.exceptionsr weaviate.schema.propertiesr weaviate.utilrrrrrrrrrOr8rCrSrrrrrrr?r@rArs"44J'=/    !. 3      8i Ti TX4D* t  0dtr@