forked from weaviate/weaviate
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.json
5268 lines (5268 loc) · 163 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"basePath": "/v1",
"consumes": [
"application/yaml",
"application/json"
],
"definitions": {
"Link": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "target of the link"
},
"rel": {
"type": "string",
"description": "relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc."
},
"name": {
"type": "string",
"description": "human readable name of the resource group"
},
"documentationHref": {
"type": "string",
"description": "weaviate documentation about this resource group"
}
}
},
"Principal": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username that was extracted either from the authentication information"
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"C11yWordsResponse": {
"description": "An array of available words and contexts.",
"properties": {
"concatenatedWord": {
"description": "Weighted results for all words",
"type": "object",
"properties": {
"concatenatedWord": {
"type": "string"
},
"singleWords": {
"type": "array",
"items": {
"format": "string"
}
},
"concatenatedVector": {
"$ref": "#/definitions/C11yVector"
},
"concatenatedNearestNeighbors": {
"$ref": "#/definitions/C11yNearestNeighbors"
}
}
},
"individualWords": {
"description": "Weighted results for per individual word",
"type": "array",
"items": {
"type": "object",
"properties": {
"word": {
"type": "string"
},
"present": {
"type": "boolean"
},
"info": {
"type": "object",
"properties": {
"vector": {
"$ref": "#/definitions/C11yVector"
},
"nearestNeighbors": {
"$ref": "#/definitions/C11yNearestNeighbors"
}
}
}
}
}
}
}
},
"C11yExtension": {
"description": "A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension",
"properties": {
"concept": {
"description": "The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'",
"type": "string",
"example": "foobarium"
},
"definition": {
"description": "A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers'",
"type": "string"
},
"weight": {
"description": "Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.",
"type": "number",
"format": "float"
}
}
},
"C11yNearestNeighbors": {
"description": "C11y function to show the nearest neighbors to a word.",
"type": "array",
"items": {
"type": "object",
"properties": {
"word": {
"type": "string"
},
"distance": {
"type": "number",
"format": "float"
}
}
}
},
"C11yVector": {
"description": "A Vector in the Contextionary",
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"Vector": {
"description": "A Vector object",
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"Vectors": {
"description": "A Multi Vector map of named vectors",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Vector"
}
},
"C11yVectorBasedQuestion": {
"description": "Receive question based on array of classes, properties and values.",
"type": "array",
"items": {
"type": "object",
"properties": {
"classVectors": {
"description": "Vectorized classname.",
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"minItems": 300,
"maxItems": 300
},
"classProps": {
"description": "Vectorized properties.",
"type": "array",
"items": {
"type": "object",
"properties": {
"propsVectors": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"value": {
"description": "String with valuename.",
"type": "string"
}
}
},
"minItems": 300,
"maxItems": 300
}
}
}
},
"Deprecation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id that uniquely identifies this particular deprecations (mostly used internally)"
},
"status": {
"type": "string",
"description": "Whether the problematic API functionality is deprecated (planned to be removed) or already removed"
},
"apiType": {
"type": "string",
"description": "Describes which API is effected, usually one of: REST, GraphQL"
},
"msg": {
"type": "string",
"description": "What this deprecation is about"
},
"mitigation": {
"type": "string",
"description": "User-required object to not be affected by the (planned) removal"
},
"sinceVersion": {
"type": "string",
"description": "The deprecation was introduced in this version"
},
"plannedRemovalVersion": {
"type": "string",
"description": "A best-effort guess of which upcoming version will remove the feature entirely"
},
"removedIn": {
"type": "string",
"description": "If the feature has already been removed, it was removed in this version",
"x-nullable": true
},
"removedTime": {
"type": "string",
"format": "date-time",
"description": "If the feature has already been removed, it was removed at this timestamp",
"x-nullable": true
},
"sinceTime": {
"type": "string",
"format": "date-time",
"description": "The deprecation was introduced in this version"
},
"locations": {
"type": "array",
"description": "The locations within the specified API affected by this deprecation",
"items": {
"type": "string"
}
}
}
},
"ErrorResponse": {
"description": "An error response given by Weaviate end-points.",
"properties": {
"error": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"GraphQLError": {
"description": "An error response caused by a GraphQL query.",
"properties": {
"locations": {
"items": {
"properties": {
"column": {
"format": "int64",
"type": "integer"
},
"line": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"type": "string"
},
"path": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"GraphQLQuery": {
"description": "GraphQL query based on: http://facebook.github.io/graphql/.",
"properties": {
"operationName": {
"description": "The name of the operation if multiple exist in the query.",
"type": "string"
},
"query": {
"description": "Query based on GraphQL syntax.",
"type": "string"
},
"variables": {
"description": "Additional variables for the query.",
"type": "object"
}
},
"type": "object"
},
"GraphQLQueries": {
"description": "A list of GraphQL queries.",
"items": {
"$ref": "#/definitions/GraphQLQuery"
},
"type": "array"
},
"GraphQLResponse": {
"description": "GraphQL based response: http://facebook.github.io/graphql/.",
"properties": {
"data": {
"additionalProperties": {
"$ref": "#/definitions/JsonObject"
},
"description": "GraphQL data object.",
"type": "object"
},
"errors": {
"description": "Array with errors.",
"items": {
"$ref": "#/definitions/GraphQLError"
},
"x-omitempty": true,
"type": "array"
}
}
},
"GraphQLResponses": {
"description": "A list of GraphQL responses.",
"items": {
"$ref": "#/definitions/GraphQLResponse"
},
"type": "array"
},
"InvertedIndexConfig": {
"description": "Configure the inverted index built into Weaviate",
"properties": {
"cleanupIntervalSeconds": {
"description": "Asynchronous index clean up happens every n seconds",
"format": "int",
"type": "number"
},
"bm25": {
"$ref": "#/definitions/BM25Config"
},
"stopwords": {
"$ref": "#/definitions/StopwordConfig"
},
"indexTimestamps": {
"description": "Index each object by its internal timestamps",
"type": "boolean"
},
"indexNullState": {
"description": "Index each object with the null state",
"type": "boolean"
},
"indexPropertyLength": {
"description": "Index length of properties",
"type": "boolean"
}
},
"type": "object"
},
"ReplicationConfig": {
"description": "Configure how replication is executed in a cluster",
"properties": {
"factor": {
"description": "Number of times a class is replicated",
"type": "integer"
}
},
"type": "object"
},
"BM25Config": {
"description": "tuning parameters for the BM25 algorithm",
"properties": {
"k1": {
"description": "calibrates term-weight scaling based on the term frequency within a document",
"format": "float",
"type": "number"
},
"b": {
"description": "calibrates term-weight scaling based on the document length",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"StopwordConfig": {
"description": "fine-grained control over stopword list usage",
"properties": {
"preset": {
"description": "pre-existing list of common words by language",
"type": "string"
},
"additions": {
"description": "stopwords to be considered additionally",
"type": "array",
"items": {
"type": "string"
}
},
"removals": {
"description": "stopwords to be removed from consideration",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"MultiTenancyConfig": {
"description": "Configuration related to multi-tenancy within a class",
"properties": {
"enabled": {
"description": "Whether or not multi-tenancy is enabled for this class",
"type": "boolean",
"x-omitempty": false
},
"autoTenantCreation": {
"description": "Nonexistent tenants should (not) be created implicitly",
"type": "boolean",
"x-omitempty": false
},
"autoTenantActivation": {
"description": "Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status",
"type": "boolean",
"x-omitempty": false
}
}
},
"JsonObject": {
"description": "JSON object value.",
"type": "object"
},
"Meta": {
"description": "Contains meta information of the current Weaviate instance.",
"properties": {
"hostname": {
"description": "The url of the host.",
"format": "url",
"type": "string"
},
"version": {
"description": "Version of weaviate you are currently running",
"type": "string"
},
"modules": {
"description": "Module-specific meta information",
"type": "object"
}
},
"type": "object"
},
"MultipleRef": {
"description": "Multiple instances of references to other objects.",
"items": {
"$ref": "#/definitions/SingleRef"
},
"type": "array"
},
"PatchDocumentObject": {
"description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).",
"properties": {
"from": {
"description": "A string containing a JSON Pointer value.",
"type": "string"
},
"op": {
"description": "The operation to be performed.",
"enum": [
"add",
"remove",
"replace",
"move",
"copy",
"test"
],
"type": "string"
},
"path": {
"description": "A JSON-Pointer.",
"type": "string"
},
"value": {
"description": "The value to be used within the operations.",
"type": "object"
},
"merge": {
"$ref": "#/definitions/Object"
}
},
"required": [
"op",
"path"
]
},
"PatchDocumentAction": {
"description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).",
"properties": {
"from": {
"description": "A string containing a JSON Pointer value.",
"type": "string"
},
"op": {
"description": "The operation to be performed.",
"enum": [
"add",
"remove",
"replace",
"move",
"copy",
"test"
],
"type": "string"
},
"path": {
"description": "A JSON-Pointer.",
"type": "string"
},
"value": {
"description": "The value to be used within the operations.",
"type": "object"
},
"merge": {
"$ref": "#/definitions/Object"
}
},
"required": [
"op",
"path"
]
},
"PeerUpdate": {
"description": "A single peer in the network.",
"properties": {
"id": {
"description": "The session ID of the peer.",
"type": "string",
"format": "uuid"
},
"name": {
"description": "Human readable name.",
"type": "string"
},
"uri": {
"description": "The location where the peer is exposed to the internet.",
"type": "string",
"format": "uri"
},
"schemaHash": {
"description": "The latest known hash of the peer's schema.",
"type": "string"
}
}
},
"PeerUpdateList": {
"description": "List of known peers.",
"items": {
"$ref": "#/definitions/PeerUpdate"
},
"type": "array"
},
"VectorWeights": {
"description": "Allow custom overrides of vector weights as math expressions. E.g. \"pancake\": \"7\" will set the weight for the word pancake to 7 in the vectorization, whereas \"w * 3\" would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.",
"type": "object"
},
"PropertySchema": {
"description": "This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition.",
"type": "object"
},
"SchemaHistory": {
"description": "This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition.",
"type": "object"
},
"Schema": {
"description": "Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).",
"properties": {
"classes": {
"description": "Semantic classes that are available.",
"items": {
"$ref": "#/definitions/Class"
},
"type": "array"
},
"maintainer": {
"description": "Email of the maintainer.",
"format": "email",
"type": "string"
},
"name": {
"description": "Name of the schema.",
"type": "string"
}
},
"type": "object"
},
"SchemaClusterStatus": {
"description": "Indicates the health of the schema in a cluster.",
"properties": {
"healthy": {
"description": "True if the cluster is in sync, false if there is an issue (see error).",
"type": "boolean",
"x-omitempty": false
},
"error": {
"description": "Contains the sync check error if one occurred",
"type": "string",
"x-omitempty": true
},
"hostname": {
"description": "Hostname of the coordinating node, i.e. the one that received the cluster. This can be useful information if the error message contains phrases such as 'other nodes agree, but local does not', etc.",
"type": "string"
},
"nodeCount": {
"description": "Number of nodes that participated in the sync check",
"type": "number",
"format": "int"
},
"ignoreSchemaSync": {
"description": "The cluster check at startup can be ignored (to recover from an out-of-sync situation).",
"type": "boolean",
"x-omitempty": false
}
},
"type": "object"
},
"Class": {
"properties": {
"class": {
"description": "Name of the class as URI relative to the schema URL.",
"type": "string"
},
"vectorConfig": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/VectorConfig"
}
},
"vectorIndexType": {
"description": "Name of the vector index to use, eg. (HNSW)",
"type": "string"
},
"vectorIndexConfig": {
"description": "Vector-index config, that is specific to the type of index selected in vectorIndexType",
"type": "object"
},
"shardingConfig": {
"description": "Manage how the index should be sharded and distributed in the cluster",
"type": "object"
},
"replicationConfig": {
"$ref": "#/definitions/ReplicationConfig"
},
"invertedIndexConfig": {
"$ref": "#/definitions/InvertedIndexConfig"
},
"multiTenancyConfig": {
"$ref": "#/definitions/MultiTenancyConfig"
},
"vectorizer": {
"description": "Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module.",
"type": "string"
},
"moduleConfig": {
"description": "Configuration specific to modules this Weaviate instance has installed",
"type": "object"
},
"description": {
"description": "Description of the class.",
"type": "string"
},
"properties": {
"description": "The properties of the class.",
"items": {
"$ref": "#/definitions/Property"
},
"type": "array"
}
},
"type": "object"
},
"Property": {
"properties": {
"dataType": {
"description": "Can be a reference to another type when it starts with a capital (for example Person), otherwise \"string\" or \"int\".",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"moduleConfig": {
"description": "Configuration specific to modules this Weaviate instance has installed",
"type": "object"
},
"name": {
"description": "Name of the property as URI relative to the schema URL.",
"type": "string"
},
"indexInverted": {
"description": "Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters, bm25 or hybrid search. This property has no affect on vectorization decisions done by modules (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)",
"type": "boolean",
"x-nullable": true
},
"indexFilterable": {
"description": "Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters. This property has no affect on vectorization decisions done by modules",
"type": "boolean",
"x-nullable": true
},
"indexSearchable": {
"description": "Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules",
"type": "boolean",
"x-nullable": true
},
"tokenization": {
"description": "Determines tokenization of the property as separate words or whole field. Optional. Applies to text and text[] data types. Allowed values are `word` (default; splits on any non-alphanumerical, lowercases), `lowercase` (splits on white spaces, lowercases), `whitespace` (splits on white spaces), `field` (trims). Not supported for remaining data types",
"type": "string",
"enum": [
"word",
"lowercase",
"whitespace",
"field",
"trigram",
"gse"
]
},
"nestedProperties": {
"description": "The properties of the nested object(s). Applies to object and object[] data types.",
"items": {
"$ref": "#/definitions/NestedProperty"
},
"type": "array",
"x-omitempty": true
}
},
"type": "object"
},
"VectorConfig": {
"properties": {
"vectorizer": {
"description": "Configuration of a specific vectorizer used by this vector",
"type": "object"
},
"vectorIndexType": {
"description": "Name of the vector index to use, eg. (HNSW)",
"type": "string"
},
"vectorIndexConfig": {
"description": "Vector-index config, that is specific to the type of index selected in vectorIndexType",
"type": "object"
}
},
"type": "object"
},
"NestedProperty": {
"properties": {
"dataType": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"indexFilterable": {
"type": "boolean",
"x-nullable": true
},
"indexSearchable": {
"type": "boolean",
"x-nullable": true
},
"tokenization": {
"type": "string",
"enum": [
"word",
"lowercase",
"whitespace",
"field"
]
},
"nestedProperties": {
"items": {
"$ref": "#/definitions/NestedProperty"
},
"type": "array",
"x-omitempty": true
}
},
"type": "object"
},
"ShardStatusList": {
"description": "The status of all the shards of a Class",
"items": {
"$ref": "#/definitions/ShardStatusGetResponse"
},
"type": "array"
},
"ShardStatusGetResponse": {
"description": "Response body of shard status get request",
"properties": {
"name": {
"description": "Name of the shard",
"type": "string"
},
"status": {
"description": "Status of the shard",
"type": "string"
},
"vectorQueueSize": {
"description": "Size of the vector queue of the shard",
"type": "integer",
"x-omitempty": false
}
}
},
"ShardStatus": {
"description": "The status of a single shard",
"properties": {
"status": {
"description": "Status of the shard",
"type": "string"
}
}
},
"BackupCreateStatusResponse": {
"description": "The definition of a backup create metadata",
"properties": {
"id": {
"description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
"type": "string"
},
"backend": {
"description": "Backup backend name e.g. filesystem, gcs, s3.",
"type": "string"
},
"path": {
"description": "destination path of backup files proper to selected backend",
"type": "string"
},
"error": {
"description": "error message if creation failed",
"type": "string"
},
"status": {
"description": "phase of backup creation process",
"type": "string",
"default": "STARTED",
"enum": [
"STARTED",
"TRANSFERRING",
"TRANSFERRED",
"SUCCESS",
"FAILED"
]
}
}
},
"BackupRestoreStatusResponse": {
"description": "The definition of a backup restore metadata",
"properties": {
"id": {
"description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
"type": "string"
},
"backend": {
"description": "Backup backend name e.g. filesystem, gcs, s3.",
"type": "string"
},
"path": {
"description": "destination path of backup files proper to selected backup backend",
"type": "string"
},
"error": {
"description": "error message if restoration failed",
"type": "string"
},
"status": {
"description": "phase of backup restoration process",
"type": "string",
"default": "STARTED",
"enum": [
"STARTED",
"TRANSFERRING",
"TRANSFERRED",
"SUCCESS",
"FAILED"
]
}
}
},
"BackupConfig": {
"description": "Backup custom configuration",
"type": "object",
"properties": {
"CPUPercentage": {
"description": "Desired CPU core utilization ranging from 1%-80%",
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 80,
"x-nullable": false
},
"ChunkSize": {
"description": "Weaviate will attempt to come close the specified size, with a minimum of 2MB, default of 128MB, and a maximum of 512MB",
"type": "integer",
"default": 128,
"minimum": 2,
"maximum": 512,
"x-nullable": false
},
"CompressionLevel": {
"description": "compression level used by compression algorithm",
"type": "string",
"default": "DefaultCompression",
"x-nullable": false,
"enum": [
"DefaultCompression",
"BestSpeed",
"BestCompression"
]
}
}
},
"RestoreConfig": {
"description": "Backup custom configuration",
"type": "object",
"properties": {
"CPUPercentage": {
"description": "Desired CPU core utilization ranging from 1%-80%",
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 80,
"x-nullable": false
}
}
},
"BackupCreateRequest": {
"description": "Request body for creating a backup of a set of classes",
"properties": {
"id": {
"description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
"type": "string"
},
"config": {
"description": "Custom configuration for the backup creation process",
"type": "object",
"$ref": "#/definitions/BackupConfig"
},
"include": {
"description": "List of classes to include in the backup creation process",
"type": "array",
"items": {
"type": "string"
}
},
"exclude": {
"description": "List of classes to exclude from the backup creation process",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BackupCreateResponse": {
"description": "The definition of a backup create response body",
"properties": {
"id": {
"description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
"type": "string"
},
"classes": {
"description": "The list of classes for which the backup creation process was started",