nucliadb-protos 6.3.7.post4116__py3-none-any.whl → 6.3.7.post4119__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1523 +0,0 @@
1
- """
2
- @generated by mypy-protobuf. Do not edit manually!
3
- isort:skip_file
4
- """
5
-
6
- import builtins
7
- import collections.abc
8
- import google.protobuf.descriptor
9
- import google.protobuf.internal.containers
10
- import google.protobuf.internal.enum_type_wrapper
11
- import google.protobuf.message
12
- import google.protobuf.timestamp_pb2
13
- import nucliadb_protos.noderesources_pb2
14
- import nucliadb_protos.utils_pb2
15
- import sys
16
- import typing
17
-
18
- if sys.version_info >= (3, 10):
19
- import typing as typing_extensions
20
- else:
21
- import typing_extensions
22
- from nucliadb_protos.noderesources_pb2 import (
23
- EmptyQuery as EmptyQuery,
24
- EmptyResponse as EmptyResponse,
25
- IndexMetadata as IndexMetadata,
26
- IndexParagraph as IndexParagraph,
27
- IndexParagraphs as IndexParagraphs,
28
- IndexRelation as IndexRelation,
29
- IndexRelations as IndexRelations,
30
- NodeMetadata as NodeMetadata,
31
- ParagraphMetadata as ParagraphMetadata,
32
- Position as Position,
33
- Representation as Representation,
34
- Resource as Resource,
35
- ResourceID as ResourceID,
36
- SentenceMetadata as SentenceMetadata,
37
- Shard as Shard,
38
- ShardCreated as ShardCreated,
39
- ShardId as ShardId,
40
- ShardIds as ShardIds,
41
- ShardMetadata as ShardMetadata,
42
- StringList as StringList,
43
- TextInformation as TextInformation,
44
- VectorSentence as VectorSentence,
45
- VectorSetID as VectorSetID,
46
- VectorSetList as VectorSetList,
47
- VectorsetSentences as VectorsetSentences,
48
- )
49
- from nucliadb_protos.utils_pb2 import (
50
- COSINE as COSINE,
51
- DOT as DOT,
52
- EXPERIMENTAL as EXPERIMENTAL,
53
- ExtractedText as ExtractedText,
54
- Relation as Relation,
55
- RelationMetadata as RelationMetadata,
56
- RelationNode as RelationNode,
57
- ReleaseChannel as ReleaseChannel,
58
- STABLE as STABLE,
59
- Security as Security,
60
- UserVector as UserVector,
61
- UserVectorSet as UserVectorSet,
62
- UserVectors as UserVectors,
63
- UserVectorsList as UserVectorsList,
64
- Vector as Vector,
65
- VectorObject as VectorObject,
66
- VectorSimilarity as VectorSimilarity,
67
- Vectors as Vectors,
68
- )
69
-
70
- DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
71
-
72
- class _FilterOperator:
73
- ValueType = typing.NewType("ValueType", builtins.int)
74
- V: typing_extensions.TypeAlias = ValueType
75
-
76
- class _FilterOperatorEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_FilterOperator.ValueType], builtins.type):
77
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
78
- AND: _FilterOperator.ValueType # 0
79
- OR: _FilterOperator.ValueType # 1
80
-
81
- class FilterOperator(_FilterOperator, metaclass=_FilterOperatorEnumTypeWrapper): ...
82
-
83
- AND: FilterOperator.ValueType # 0
84
- OR: FilterOperator.ValueType # 1
85
- global___FilterOperator = FilterOperator
86
-
87
- class _SuggestFeatures:
88
- ValueType = typing.NewType("ValueType", builtins.int)
89
- V: typing_extensions.TypeAlias = ValueType
90
-
91
- class _SuggestFeaturesEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_SuggestFeatures.ValueType], builtins.type):
92
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
93
- ENTITIES: _SuggestFeatures.ValueType # 0
94
- PARAGRAPHS: _SuggestFeatures.ValueType # 1
95
-
96
- class SuggestFeatures(_SuggestFeatures, metaclass=_SuggestFeaturesEnumTypeWrapper): ...
97
-
98
- ENTITIES: SuggestFeatures.ValueType # 0
99
- PARAGRAPHS: SuggestFeatures.ValueType # 1
100
- global___SuggestFeatures = SuggestFeatures
101
-
102
- @typing.final
103
- class StreamFilter(google.protobuf.message.Message):
104
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
105
-
106
- class _Conjunction:
107
- ValueType = typing.NewType("ValueType", builtins.int)
108
- V: typing_extensions.TypeAlias = ValueType
109
-
110
- class _ConjunctionEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[StreamFilter._Conjunction.ValueType], builtins.type):
111
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
112
- AND: StreamFilter._Conjunction.ValueType # 0
113
- OR: StreamFilter._Conjunction.ValueType # 1
114
- NOT: StreamFilter._Conjunction.ValueType # 2
115
-
116
- class Conjunction(_Conjunction, metaclass=_ConjunctionEnumTypeWrapper): ...
117
- AND: StreamFilter.Conjunction.ValueType # 0
118
- OR: StreamFilter.Conjunction.ValueType # 1
119
- NOT: StreamFilter.Conjunction.ValueType # 2
120
-
121
- CONJUNCTION_FIELD_NUMBER: builtins.int
122
- LABELS_FIELD_NUMBER: builtins.int
123
- conjunction: global___StreamFilter.Conjunction.ValueType
124
- @property
125
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
126
- def __init__(
127
- self,
128
- *,
129
- conjunction: global___StreamFilter.Conjunction.ValueType = ...,
130
- labels: collections.abc.Iterable[builtins.str] | None = ...,
131
- ) -> None: ...
132
- def ClearField(self, field_name: typing.Literal["conjunction", b"conjunction", "labels", b"labels"]) -> None: ...
133
-
134
- global___StreamFilter = StreamFilter
135
-
136
- @typing.final
137
- class Faceted(google.protobuf.message.Message):
138
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
139
-
140
- LABELS_FIELD_NUMBER: builtins.int
141
- @property
142
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
143
- def __init__(
144
- self,
145
- *,
146
- labels: collections.abc.Iterable[builtins.str] | None = ...,
147
- ) -> None: ...
148
- def ClearField(self, field_name: typing.Literal["labels", b"labels"]) -> None: ...
149
-
150
- global___Faceted = Faceted
151
-
152
- @typing.final
153
- class OrderBy(google.protobuf.message.Message):
154
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
155
-
156
- class _OrderType:
157
- ValueType = typing.NewType("ValueType", builtins.int)
158
- V: typing_extensions.TypeAlias = ValueType
159
-
160
- class _OrderTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[OrderBy._OrderType.ValueType], builtins.type):
161
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
162
- DESC: OrderBy._OrderType.ValueType # 0
163
- ASC: OrderBy._OrderType.ValueType # 1
164
-
165
- class OrderType(_OrderType, metaclass=_OrderTypeEnumTypeWrapper): ...
166
- DESC: OrderBy.OrderType.ValueType # 0
167
- ASC: OrderBy.OrderType.ValueType # 1
168
-
169
- class _OrderField:
170
- ValueType = typing.NewType("ValueType", builtins.int)
171
- V: typing_extensions.TypeAlias = ValueType
172
-
173
- class _OrderFieldEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[OrderBy._OrderField.ValueType], builtins.type):
174
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
175
- CREATED: OrderBy._OrderField.ValueType # 0
176
- MODIFIED: OrderBy._OrderField.ValueType # 1
177
-
178
- class OrderField(_OrderField, metaclass=_OrderFieldEnumTypeWrapper): ...
179
- CREATED: OrderBy.OrderField.ValueType # 0
180
- MODIFIED: OrderBy.OrderField.ValueType # 1
181
-
182
- FIELD_FIELD_NUMBER: builtins.int
183
- TYPE_FIELD_NUMBER: builtins.int
184
- SORT_BY_FIELD_NUMBER: builtins.int
185
- field: builtins.str
186
- type: global___OrderBy.OrderType.ValueType
187
- sort_by: global___OrderBy.OrderField.ValueType
188
- def __init__(
189
- self,
190
- *,
191
- field: builtins.str = ...,
192
- type: global___OrderBy.OrderType.ValueType = ...,
193
- sort_by: global___OrderBy.OrderField.ValueType = ...,
194
- ) -> None: ...
195
- def ClearField(self, field_name: typing.Literal["field", b"field", "sort_by", b"sort_by", "type", b"type"]) -> None: ...
196
-
197
- global___OrderBy = OrderBy
198
-
199
- @typing.final
200
- class FacetResult(google.protobuf.message.Message):
201
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
202
-
203
- TAG_FIELD_NUMBER: builtins.int
204
- TOTAL_FIELD_NUMBER: builtins.int
205
- tag: builtins.str
206
- total: builtins.int
207
- def __init__(
208
- self,
209
- *,
210
- tag: builtins.str = ...,
211
- total: builtins.int = ...,
212
- ) -> None: ...
213
- def ClearField(self, field_name: typing.Literal["tag", b"tag", "total", b"total"]) -> None: ...
214
-
215
- global___FacetResult = FacetResult
216
-
217
- @typing.final
218
- class FacetResults(google.protobuf.message.Message):
219
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
220
-
221
- FACETRESULTS_FIELD_NUMBER: builtins.int
222
- @property
223
- def facetresults(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FacetResult]: ...
224
- def __init__(
225
- self,
226
- *,
227
- facetresults: collections.abc.Iterable[global___FacetResult] | None = ...,
228
- ) -> None: ...
229
- def ClearField(self, field_name: typing.Literal["facetresults", b"facetresults"]) -> None: ...
230
-
231
- global___FacetResults = FacetResults
232
-
233
- @typing.final
234
- class ResultScore(google.protobuf.message.Message):
235
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
236
-
237
- BM25_FIELD_NUMBER: builtins.int
238
- BOOSTER_FIELD_NUMBER: builtins.int
239
- bm25: builtins.float
240
- booster: builtins.float
241
- """In the case of two equal bm25 scores, booster
242
- decides
243
- """
244
- def __init__(
245
- self,
246
- *,
247
- bm25: builtins.float = ...,
248
- booster: builtins.float = ...,
249
- ) -> None: ...
250
- def ClearField(self, field_name: typing.Literal["bm25", b"bm25", "booster", b"booster"]) -> None: ...
251
-
252
- global___ResultScore = ResultScore
253
-
254
- @typing.final
255
- class DocumentResult(google.protobuf.message.Message):
256
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
257
-
258
- UUID_FIELD_NUMBER: builtins.int
259
- SCORE_FIELD_NUMBER: builtins.int
260
- FIELD_FIELD_NUMBER: builtins.int
261
- LABELS_FIELD_NUMBER: builtins.int
262
- uuid: builtins.str
263
- field: builtins.str
264
- @property
265
- def score(self) -> global___ResultScore: ...
266
- @property
267
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
268
- def __init__(
269
- self,
270
- *,
271
- uuid: builtins.str = ...,
272
- score: global___ResultScore | None = ...,
273
- field: builtins.str = ...,
274
- labels: collections.abc.Iterable[builtins.str] | None = ...,
275
- ) -> None: ...
276
- def HasField(self, field_name: typing.Literal["score", b"score"]) -> builtins.bool: ...
277
- def ClearField(self, field_name: typing.Literal["field", b"field", "labels", b"labels", "score", b"score", "uuid", b"uuid"]) -> None: ...
278
-
279
- global___DocumentResult = DocumentResult
280
-
281
- @typing.final
282
- class DocumentSearchResponse(google.protobuf.message.Message):
283
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
284
-
285
- @typing.final
286
- class FacetsEntry(google.protobuf.message.Message):
287
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
288
-
289
- KEY_FIELD_NUMBER: builtins.int
290
- VALUE_FIELD_NUMBER: builtins.int
291
- key: builtins.str
292
- @property
293
- def value(self) -> global___FacetResults: ...
294
- def __init__(
295
- self,
296
- *,
297
- key: builtins.str = ...,
298
- value: global___FacetResults | None = ...,
299
- ) -> None: ...
300
- def HasField(self, field_name: typing.Literal["value", b"value"]) -> builtins.bool: ...
301
- def ClearField(self, field_name: typing.Literal["key", b"key", "value", b"value"]) -> None: ...
302
-
303
- TOTAL_FIELD_NUMBER: builtins.int
304
- RESULTS_FIELD_NUMBER: builtins.int
305
- FACETS_FIELD_NUMBER: builtins.int
306
- PAGE_NUMBER_FIELD_NUMBER: builtins.int
307
- RESULT_PER_PAGE_FIELD_NUMBER: builtins.int
308
- QUERY_FIELD_NUMBER: builtins.int
309
- NEXT_PAGE_FIELD_NUMBER: builtins.int
310
- BM25_FIELD_NUMBER: builtins.int
311
- total: builtins.int
312
- page_number: builtins.int
313
- result_per_page: builtins.int
314
- query: builtins.str
315
- """The text that lead to this results"""
316
- next_page: builtins.bool
317
- """Is there a next page"""
318
- bm25: builtins.bool
319
- @property
320
- def results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DocumentResult]: ...
321
- @property
322
- def facets(self) -> google.protobuf.internal.containers.MessageMap[builtins.str, global___FacetResults]: ...
323
- def __init__(
324
- self,
325
- *,
326
- total: builtins.int = ...,
327
- results: collections.abc.Iterable[global___DocumentResult] | None = ...,
328
- facets: collections.abc.Mapping[builtins.str, global___FacetResults] | None = ...,
329
- page_number: builtins.int = ...,
330
- result_per_page: builtins.int = ...,
331
- query: builtins.str = ...,
332
- next_page: builtins.bool = ...,
333
- bm25: builtins.bool = ...,
334
- ) -> None: ...
335
- def ClearField(self, field_name: typing.Literal["bm25", b"bm25", "facets", b"facets", "next_page", b"next_page", "page_number", b"page_number", "query", b"query", "result_per_page", b"result_per_page", "results", b"results", "total", b"total"]) -> None: ...
336
-
337
- global___DocumentSearchResponse = DocumentSearchResponse
338
-
339
- @typing.final
340
- class ParagraphResult(google.protobuf.message.Message):
341
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
342
-
343
- UUID_FIELD_NUMBER: builtins.int
344
- FIELD_FIELD_NUMBER: builtins.int
345
- START_FIELD_NUMBER: builtins.int
346
- END_FIELD_NUMBER: builtins.int
347
- PARAGRAPH_FIELD_NUMBER: builtins.int
348
- SPLIT_FIELD_NUMBER: builtins.int
349
- INDEX_FIELD_NUMBER: builtins.int
350
- SCORE_FIELD_NUMBER: builtins.int
351
- MATCHES_FIELD_NUMBER: builtins.int
352
- METADATA_FIELD_NUMBER: builtins.int
353
- LABELS_FIELD_NUMBER: builtins.int
354
- uuid: builtins.str
355
- field: builtins.str
356
- start: builtins.int
357
- end: builtins.int
358
- paragraph: builtins.str
359
- split: builtins.str
360
- index: builtins.int
361
- @property
362
- def score(self) -> global___ResultScore: ...
363
- @property
364
- def matches(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
365
- @property
366
- def metadata(self) -> nucliadb_protos.noderesources_pb2.ParagraphMetadata:
367
- """Metadata that can't be searched with but is returned on search results"""
368
-
369
- @property
370
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
371
- def __init__(
372
- self,
373
- *,
374
- uuid: builtins.str = ...,
375
- field: builtins.str = ...,
376
- start: builtins.int = ...,
377
- end: builtins.int = ...,
378
- paragraph: builtins.str = ...,
379
- split: builtins.str = ...,
380
- index: builtins.int = ...,
381
- score: global___ResultScore | None = ...,
382
- matches: collections.abc.Iterable[builtins.str] | None = ...,
383
- metadata: nucliadb_protos.noderesources_pb2.ParagraphMetadata | None = ...,
384
- labels: collections.abc.Iterable[builtins.str] | None = ...,
385
- ) -> None: ...
386
- def HasField(self, field_name: typing.Literal["metadata", b"metadata", "score", b"score"]) -> builtins.bool: ...
387
- def ClearField(self, field_name: typing.Literal["end", b"end", "field", b"field", "index", b"index", "labels", b"labels", "matches", b"matches", "metadata", b"metadata", "paragraph", b"paragraph", "score", b"score", "split", b"split", "start", b"start", "uuid", b"uuid"]) -> None: ...
388
-
389
- global___ParagraphResult = ParagraphResult
390
-
391
- @typing.final
392
- class ParagraphSearchResponse(google.protobuf.message.Message):
393
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
394
-
395
- @typing.final
396
- class FacetsEntry(google.protobuf.message.Message):
397
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
398
-
399
- KEY_FIELD_NUMBER: builtins.int
400
- VALUE_FIELD_NUMBER: builtins.int
401
- key: builtins.str
402
- @property
403
- def value(self) -> global___FacetResults: ...
404
- def __init__(
405
- self,
406
- *,
407
- key: builtins.str = ...,
408
- value: global___FacetResults | None = ...,
409
- ) -> None: ...
410
- def HasField(self, field_name: typing.Literal["value", b"value"]) -> builtins.bool: ...
411
- def ClearField(self, field_name: typing.Literal["key", b"key", "value", b"value"]) -> None: ...
412
-
413
- FUZZY_DISTANCE_FIELD_NUMBER: builtins.int
414
- TOTAL_FIELD_NUMBER: builtins.int
415
- RESULTS_FIELD_NUMBER: builtins.int
416
- FACETS_FIELD_NUMBER: builtins.int
417
- PAGE_NUMBER_FIELD_NUMBER: builtins.int
418
- RESULT_PER_PAGE_FIELD_NUMBER: builtins.int
419
- QUERY_FIELD_NUMBER: builtins.int
420
- NEXT_PAGE_FIELD_NUMBER: builtins.int
421
- BM25_FIELD_NUMBER: builtins.int
422
- EMATCHES_FIELD_NUMBER: builtins.int
423
- fuzzy_distance: builtins.int
424
- total: builtins.int
425
- page_number: builtins.int
426
- """What page is the answer."""
427
- result_per_page: builtins.int
428
- """How many results are in this page."""
429
- query: builtins.str
430
- """The text that lead to this results"""
431
- next_page: builtins.bool
432
- """Is there a next page"""
433
- bm25: builtins.bool
434
- @property
435
- def results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ParagraphResult]: ...
436
- @property
437
- def facets(self) -> google.protobuf.internal.containers.MessageMap[builtins.str, global___FacetResults]:
438
- """For each field what facets are."""
439
-
440
- @property
441
- def ematches(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
442
- def __init__(
443
- self,
444
- *,
445
- fuzzy_distance: builtins.int = ...,
446
- total: builtins.int = ...,
447
- results: collections.abc.Iterable[global___ParagraphResult] | None = ...,
448
- facets: collections.abc.Mapping[builtins.str, global___FacetResults] | None = ...,
449
- page_number: builtins.int = ...,
450
- result_per_page: builtins.int = ...,
451
- query: builtins.str = ...,
452
- next_page: builtins.bool = ...,
453
- bm25: builtins.bool = ...,
454
- ematches: collections.abc.Iterable[builtins.str] | None = ...,
455
- ) -> None: ...
456
- def ClearField(self, field_name: typing.Literal["bm25", b"bm25", "ematches", b"ematches", "facets", b"facets", "fuzzy_distance", b"fuzzy_distance", "next_page", b"next_page", "page_number", b"page_number", "query", b"query", "result_per_page", b"result_per_page", "results", b"results", "total", b"total"]) -> None: ...
457
-
458
- global___ParagraphSearchResponse = ParagraphSearchResponse
459
-
460
- @typing.final
461
- class DocumentVectorIdentifier(google.protobuf.message.Message):
462
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
463
-
464
- ID_FIELD_NUMBER: builtins.int
465
- id: builtins.str
466
- def __init__(
467
- self,
468
- *,
469
- id: builtins.str = ...,
470
- ) -> None: ...
471
- def ClearField(self, field_name: typing.Literal["id", b"id"]) -> None: ...
472
-
473
- global___DocumentVectorIdentifier = DocumentVectorIdentifier
474
-
475
- @typing.final
476
- class DocumentScored(google.protobuf.message.Message):
477
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
478
-
479
- DOC_ID_FIELD_NUMBER: builtins.int
480
- SCORE_FIELD_NUMBER: builtins.int
481
- METADATA_FIELD_NUMBER: builtins.int
482
- LABELS_FIELD_NUMBER: builtins.int
483
- score: builtins.float
484
- @property
485
- def doc_id(self) -> global___DocumentVectorIdentifier: ...
486
- @property
487
- def metadata(self) -> nucliadb_protos.noderesources_pb2.SentenceMetadata: ...
488
- @property
489
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
490
- def __init__(
491
- self,
492
- *,
493
- doc_id: global___DocumentVectorIdentifier | None = ...,
494
- score: builtins.float = ...,
495
- metadata: nucliadb_protos.noderesources_pb2.SentenceMetadata | None = ...,
496
- labels: collections.abc.Iterable[builtins.str] | None = ...,
497
- ) -> None: ...
498
- def HasField(self, field_name: typing.Literal["doc_id", b"doc_id", "metadata", b"metadata"]) -> builtins.bool: ...
499
- def ClearField(self, field_name: typing.Literal["doc_id", b"doc_id", "labels", b"labels", "metadata", b"metadata", "score", b"score"]) -> None: ...
500
-
501
- global___DocumentScored = DocumentScored
502
-
503
- @typing.final
504
- class VectorSearchResponse(google.protobuf.message.Message):
505
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
506
-
507
- DOCUMENTS_FIELD_NUMBER: builtins.int
508
- PAGE_NUMBER_FIELD_NUMBER: builtins.int
509
- RESULT_PER_PAGE_FIELD_NUMBER: builtins.int
510
- page_number: builtins.int
511
- """What page is the answer."""
512
- result_per_page: builtins.int
513
- """How many results are in this page."""
514
- @property
515
- def documents(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DocumentScored]:
516
- """List of docs closer to the asked one."""
517
-
518
- def __init__(
519
- self,
520
- *,
521
- documents: collections.abc.Iterable[global___DocumentScored] | None = ...,
522
- page_number: builtins.int = ...,
523
- result_per_page: builtins.int = ...,
524
- ) -> None: ...
525
- def ClearField(self, field_name: typing.Literal["documents", b"documents", "page_number", b"page_number", "result_per_page", b"result_per_page"]) -> None: ...
526
-
527
- global___VectorSearchResponse = VectorSearchResponse
528
-
529
- @typing.final
530
- class RelationPrefixSearchResponse(google.protobuf.message.Message):
531
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
532
-
533
- NODES_FIELD_NUMBER: builtins.int
534
- @property
535
- def nodes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.utils_pb2.RelationNode]: ...
536
- def __init__(
537
- self,
538
- *,
539
- nodes: collections.abc.Iterable[nucliadb_protos.utils_pb2.RelationNode] | None = ...,
540
- ) -> None: ...
541
- def ClearField(self, field_name: typing.Literal["nodes", b"nodes"]) -> None: ...
542
-
543
- global___RelationPrefixSearchResponse = RelationPrefixSearchResponse
544
-
545
- @typing.final
546
- class GraphQuery(google.protobuf.message.Message):
547
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
548
-
549
- @typing.final
550
- class Node(google.protobuf.message.Message):
551
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
552
-
553
- class _MatchKind:
554
- ValueType = typing.NewType("ValueType", builtins.int)
555
- V: typing_extensions.TypeAlias = ValueType
556
-
557
- class _MatchKindEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphQuery.Node._MatchKind.ValueType], builtins.type):
558
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
559
- DEPRECATED_EXACT: GraphQuery.Node._MatchKind.ValueType # 0
560
- DEPRECATED_FUZZY: GraphQuery.Node._MatchKind.ValueType # 1
561
-
562
- class MatchKind(_MatchKind, metaclass=_MatchKindEnumTypeWrapper): ...
563
- DEPRECATED_EXACT: GraphQuery.Node.MatchKind.ValueType # 0
564
- DEPRECATED_FUZZY: GraphQuery.Node.MatchKind.ValueType # 1
565
-
566
- class _MatchLocation:
567
- ValueType = typing.NewType("ValueType", builtins.int)
568
- V: typing_extensions.TypeAlias = ValueType
569
-
570
- class _MatchLocationEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphQuery.Node._MatchLocation.ValueType], builtins.type):
571
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
572
- FULL: GraphQuery.Node._MatchLocation.ValueType # 0
573
- """Match full value. Search "Rosa Parks" to find "Rosa Parks" """
574
- PREFIX: GraphQuery.Node._MatchLocation.ValueType # 1
575
- """Match prefix. Search "Rosa P" or "Ros" to find "Rosa Parks" """
576
- WORDS: GraphQuery.Node._MatchLocation.ValueType # 2
577
- """Match individual words. Search "Rosa" or "Parks" to find "Rosa Parks" """
578
- PREFIX_WORDS: GraphQuery.Node._MatchLocation.ValueType # 3
579
- """Match individual word by prefix. Search "Ros" or "Par" to find "Rosa Parks" """
580
-
581
- class MatchLocation(_MatchLocation, metaclass=_MatchLocationEnumTypeWrapper): ...
582
- FULL: GraphQuery.Node.MatchLocation.ValueType # 0
583
- """Match full value. Search "Rosa Parks" to find "Rosa Parks" """
584
- PREFIX: GraphQuery.Node.MatchLocation.ValueType # 1
585
- """Match prefix. Search "Rosa P" or "Ros" to find "Rosa Parks" """
586
- WORDS: GraphQuery.Node.MatchLocation.ValueType # 2
587
- """Match individual words. Search "Rosa" or "Parks" to find "Rosa Parks" """
588
- PREFIX_WORDS: GraphQuery.Node.MatchLocation.ValueType # 3
589
- """Match individual word by prefix. Search "Ros" or "Par" to find "Rosa Parks" """
590
-
591
- @typing.final
592
- class ExactMatch(google.protobuf.message.Message):
593
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
594
-
595
- KIND_FIELD_NUMBER: builtins.int
596
- kind: global___GraphQuery.Node.MatchLocation.ValueType
597
- def __init__(
598
- self,
599
- *,
600
- kind: global___GraphQuery.Node.MatchLocation.ValueType = ...,
601
- ) -> None: ...
602
- def ClearField(self, field_name: typing.Literal["kind", b"kind"]) -> None: ...
603
-
604
- @typing.final
605
- class FuzzyMatch(google.protobuf.message.Message):
606
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
607
-
608
- KIND_FIELD_NUMBER: builtins.int
609
- DISTANCE_FIELD_NUMBER: builtins.int
610
- kind: global___GraphQuery.Node.MatchLocation.ValueType
611
- distance: builtins.int
612
- def __init__(
613
- self,
614
- *,
615
- kind: global___GraphQuery.Node.MatchLocation.ValueType = ...,
616
- distance: builtins.int = ...,
617
- ) -> None: ...
618
- def ClearField(self, field_name: typing.Literal["distance", b"distance", "kind", b"kind"]) -> None: ...
619
-
620
- VALUE_FIELD_NUMBER: builtins.int
621
- NODE_TYPE_FIELD_NUMBER: builtins.int
622
- NODE_SUBTYPE_FIELD_NUMBER: builtins.int
623
- MATCH_KIND_FIELD_NUMBER: builtins.int
624
- EXACT_FIELD_NUMBER: builtins.int
625
- FUZZY_FIELD_NUMBER: builtins.int
626
- value: builtins.str
627
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType
628
- node_subtype: builtins.str
629
- match_kind: global___GraphQuery.Node.MatchKind.ValueType
630
- @property
631
- def exact(self) -> global___GraphQuery.Node.ExactMatch: ...
632
- @property
633
- def fuzzy(self) -> global___GraphQuery.Node.FuzzyMatch: ...
634
- def __init__(
635
- self,
636
- *,
637
- value: builtins.str | None = ...,
638
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType | None = ...,
639
- node_subtype: builtins.str | None = ...,
640
- match_kind: global___GraphQuery.Node.MatchKind.ValueType = ...,
641
- exact: global___GraphQuery.Node.ExactMatch | None = ...,
642
- fuzzy: global___GraphQuery.Node.FuzzyMatch | None = ...,
643
- ) -> None: ...
644
- def HasField(self, field_name: typing.Literal["_node_subtype", b"_node_subtype", "_node_type", b"_node_type", "_value", b"_value", "exact", b"exact", "fuzzy", b"fuzzy", "new_match_kind", b"new_match_kind", "node_subtype", b"node_subtype", "node_type", b"node_type", "value", b"value"]) -> builtins.bool: ...
645
- def ClearField(self, field_name: typing.Literal["_node_subtype", b"_node_subtype", "_node_type", b"_node_type", "_value", b"_value", "exact", b"exact", "fuzzy", b"fuzzy", "match_kind", b"match_kind", "new_match_kind", b"new_match_kind", "node_subtype", b"node_subtype", "node_type", b"node_type", "value", b"value"]) -> None: ...
646
- @typing.overload
647
- def WhichOneof(self, oneof_group: typing.Literal["_node_subtype", b"_node_subtype"]) -> typing.Literal["node_subtype"] | None: ...
648
- @typing.overload
649
- def WhichOneof(self, oneof_group: typing.Literal["_node_type", b"_node_type"]) -> typing.Literal["node_type"] | None: ...
650
- @typing.overload
651
- def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
652
- @typing.overload
653
- def WhichOneof(self, oneof_group: typing.Literal["new_match_kind", b"new_match_kind"]) -> typing.Literal["exact", "fuzzy"] | None: ...
654
-
655
- @typing.final
656
- class Relation(google.protobuf.message.Message):
657
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
658
-
659
- VALUE_FIELD_NUMBER: builtins.int
660
- RELATION_TYPE_FIELD_NUMBER: builtins.int
661
- value: builtins.str
662
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
663
- def __init__(
664
- self,
665
- *,
666
- value: builtins.str | None = ...,
667
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType | None = ...,
668
- ) -> None: ...
669
- def HasField(self, field_name: typing.Literal["_relation_type", b"_relation_type", "_value", b"_value", "relation_type", b"relation_type", "value", b"value"]) -> builtins.bool: ...
670
- def ClearField(self, field_name: typing.Literal["_relation_type", b"_relation_type", "_value", b"_value", "relation_type", b"relation_type", "value", b"value"]) -> None: ...
671
- @typing.overload
672
- def WhichOneof(self, oneof_group: typing.Literal["_relation_type", b"_relation_type"]) -> typing.Literal["relation_type"] | None: ...
673
- @typing.overload
674
- def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
675
-
676
- @typing.final
677
- class Path(google.protobuf.message.Message):
678
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
679
-
680
- SOURCE_FIELD_NUMBER: builtins.int
681
- RELATION_FIELD_NUMBER: builtins.int
682
- DESTINATION_FIELD_NUMBER: builtins.int
683
- UNDIRECTED_FIELD_NUMBER: builtins.int
684
- undirected: builtins.bool
685
- @property
686
- def source(self) -> global___GraphQuery.Node: ...
687
- @property
688
- def relation(self) -> global___GraphQuery.Relation: ...
689
- @property
690
- def destination(self) -> global___GraphQuery.Node: ...
691
- def __init__(
692
- self,
693
- *,
694
- source: global___GraphQuery.Node | None = ...,
695
- relation: global___GraphQuery.Relation | None = ...,
696
- destination: global___GraphQuery.Node | None = ...,
697
- undirected: builtins.bool = ...,
698
- ) -> None: ...
699
- def HasField(self, field_name: typing.Literal["_destination", b"_destination", "_relation", b"_relation", "_source", b"_source", "destination", b"destination", "relation", b"relation", "source", b"source"]) -> builtins.bool: ...
700
- def ClearField(self, field_name: typing.Literal["_destination", b"_destination", "_relation", b"_relation", "_source", b"_source", "destination", b"destination", "relation", b"relation", "source", b"source", "undirected", b"undirected"]) -> None: ...
701
- @typing.overload
702
- def WhichOneof(self, oneof_group: typing.Literal["_destination", b"_destination"]) -> typing.Literal["destination"] | None: ...
703
- @typing.overload
704
- def WhichOneof(self, oneof_group: typing.Literal["_relation", b"_relation"]) -> typing.Literal["relation"] | None: ...
705
- @typing.overload
706
- def WhichOneof(self, oneof_group: typing.Literal["_source", b"_source"]) -> typing.Literal["source"] | None: ...
707
-
708
- @typing.final
709
- class BoolQuery(google.protobuf.message.Message):
710
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
711
-
712
- OPERANDS_FIELD_NUMBER: builtins.int
713
- @property
714
- def operands(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphQuery.PathQuery]: ...
715
- def __init__(
716
- self,
717
- *,
718
- operands: collections.abc.Iterable[global___GraphQuery.PathQuery] | None = ...,
719
- ) -> None: ...
720
- def ClearField(self, field_name: typing.Literal["operands", b"operands"]) -> None: ...
721
-
722
- @typing.final
723
- class FacetFilter(google.protobuf.message.Message):
724
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
725
-
726
- FACET_FIELD_NUMBER: builtins.int
727
- facet: builtins.str
728
- def __init__(
729
- self,
730
- *,
731
- facet: builtins.str = ...,
732
- ) -> None: ...
733
- def ClearField(self, field_name: typing.Literal["facet", b"facet"]) -> None: ...
734
-
735
- @typing.final
736
- class PathQuery(google.protobuf.message.Message):
737
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
738
-
739
- PATH_FIELD_NUMBER: builtins.int
740
- BOOL_NOT_FIELD_NUMBER: builtins.int
741
- BOOL_AND_FIELD_NUMBER: builtins.int
742
- BOOL_OR_FIELD_NUMBER: builtins.int
743
- FACET_FIELD_NUMBER: builtins.int
744
- @property
745
- def path(self) -> global___GraphQuery.Path: ...
746
- @property
747
- def bool_not(self) -> global___GraphQuery.PathQuery: ...
748
- @property
749
- def bool_and(self) -> global___GraphQuery.BoolQuery: ...
750
- @property
751
- def bool_or(self) -> global___GraphQuery.BoolQuery: ...
752
- @property
753
- def facet(self) -> global___GraphQuery.FacetFilter: ...
754
- def __init__(
755
- self,
756
- *,
757
- path: global___GraphQuery.Path | None = ...,
758
- bool_not: global___GraphQuery.PathQuery | None = ...,
759
- bool_and: global___GraphQuery.BoolQuery | None = ...,
760
- bool_or: global___GraphQuery.BoolQuery | None = ...,
761
- facet: global___GraphQuery.FacetFilter | None = ...,
762
- ) -> None: ...
763
- def HasField(self, field_name: typing.Literal["bool_and", b"bool_and", "bool_not", b"bool_not", "bool_or", b"bool_or", "facet", b"facet", "path", b"path", "query", b"query"]) -> builtins.bool: ...
764
- def ClearField(self, field_name: typing.Literal["bool_and", b"bool_and", "bool_not", b"bool_not", "bool_or", b"bool_or", "facet", b"facet", "path", b"path", "query", b"query"]) -> None: ...
765
- def WhichOneof(self, oneof_group: typing.Literal["query", b"query"]) -> typing.Literal["path", "bool_not", "bool_and", "bool_or", "facet"] | None: ...
766
-
767
- PATH_FIELD_NUMBER: builtins.int
768
- @property
769
- def path(self) -> global___GraphQuery.PathQuery:
770
- """Search directed/undirected paths (triplets of node-relation-node). It
771
- can also be used to express node and relation queries
772
- """
773
-
774
- def __init__(
775
- self,
776
- *,
777
- path: global___GraphQuery.PathQuery | None = ...,
778
- ) -> None: ...
779
- def HasField(self, field_name: typing.Literal["path", b"path"]) -> builtins.bool: ...
780
- def ClearField(self, field_name: typing.Literal["path", b"path"]) -> None: ...
781
-
782
- global___GraphQuery = GraphQuery
783
-
784
- @typing.final
785
- class GraphSearchRequest(google.protobuf.message.Message):
786
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
787
-
788
- class _QueryKind:
789
- ValueType = typing.NewType("ValueType", builtins.int)
790
- V: typing_extensions.TypeAlias = ValueType
791
-
792
- class _QueryKindEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphSearchRequest._QueryKind.ValueType], builtins.type):
793
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
794
- PATH: GraphSearchRequest._QueryKind.ValueType # 0
795
- NODES: GraphSearchRequest._QueryKind.ValueType # 1
796
- RELATIONS: GraphSearchRequest._QueryKind.ValueType # 2
797
-
798
- class QueryKind(_QueryKind, metaclass=_QueryKindEnumTypeWrapper):
799
- """Decides what do we want in return: paths (triplets), nodes or relations.
800
- Returning paths implies returning nodes and relations.
801
- """
802
-
803
- PATH: GraphSearchRequest.QueryKind.ValueType # 0
804
- NODES: GraphSearchRequest.QueryKind.ValueType # 1
805
- RELATIONS: GraphSearchRequest.QueryKind.ValueType # 2
806
-
807
- SHARD_FIELD_NUMBER: builtins.int
808
- QUERY_FIELD_NUMBER: builtins.int
809
- KIND_FIELD_NUMBER: builtins.int
810
- TOP_K_FIELD_NUMBER: builtins.int
811
- SECURITY_FIELD_NUMBER: builtins.int
812
- FIELD_FILTER_FIELD_NUMBER: builtins.int
813
- shard: builtins.str
814
- kind: global___GraphSearchRequest.QueryKind.ValueType
815
- top_k: builtins.int
816
- @property
817
- def query(self) -> global___GraphQuery: ...
818
- @property
819
- def security(self) -> nucliadb_protos.utils_pb2.Security: ...
820
- @property
821
- def field_filter(self) -> global___FilterExpression: ...
822
- def __init__(
823
- self,
824
- *,
825
- shard: builtins.str = ...,
826
- query: global___GraphQuery | None = ...,
827
- kind: global___GraphSearchRequest.QueryKind.ValueType = ...,
828
- top_k: builtins.int = ...,
829
- security: nucliadb_protos.utils_pb2.Security | None = ...,
830
- field_filter: global___FilterExpression | None = ...,
831
- ) -> None: ...
832
- def HasField(self, field_name: typing.Literal["_field_filter", b"_field_filter", "_security", b"_security", "field_filter", b"field_filter", "query", b"query", "security", b"security"]) -> builtins.bool: ...
833
- def ClearField(self, field_name: typing.Literal["_field_filter", b"_field_filter", "_security", b"_security", "field_filter", b"field_filter", "kind", b"kind", "query", b"query", "security", b"security", "shard", b"shard", "top_k", b"top_k"]) -> None: ...
834
- @typing.overload
835
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
836
- @typing.overload
837
- def WhichOneof(self, oneof_group: typing.Literal["_security", b"_security"]) -> typing.Literal["security"] | None: ...
838
-
839
- global___GraphSearchRequest = GraphSearchRequest
840
-
841
- @typing.final
842
- class GraphSearchResponse(google.protobuf.message.Message):
843
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
844
-
845
- @typing.final
846
- class Relation(google.protobuf.message.Message):
847
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
848
-
849
- RELATION_TYPE_FIELD_NUMBER: builtins.int
850
- LABEL_FIELD_NUMBER: builtins.int
851
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
852
- label: builtins.str
853
- def __init__(
854
- self,
855
- *,
856
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType = ...,
857
- label: builtins.str = ...,
858
- ) -> None: ...
859
- def ClearField(self, field_name: typing.Literal["label", b"label", "relation_type", b"relation_type"]) -> None: ...
860
-
861
- @typing.final
862
- class Path(google.protobuf.message.Message):
863
- """To optimize proto size, paths are built using pointers to nodes and
864
- relations. This avoid repetition of nodes/relations and allow smaller
865
- protos for big graphs.
866
- """
867
-
868
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
869
-
870
- SOURCE_FIELD_NUMBER: builtins.int
871
- RELATION_FIELD_NUMBER: builtins.int
872
- DESTINATION_FIELD_NUMBER: builtins.int
873
- METADATA_FIELD_NUMBER: builtins.int
874
- RESOURCE_FIELD_ID_FIELD_NUMBER: builtins.int
875
- FACETS_FIELD_NUMBER: builtins.int
876
- source: builtins.int
877
- relation: builtins.int
878
- destination: builtins.int
879
- resource_field_id: builtins.str
880
- @property
881
- def metadata(self) -> nucliadb_protos.utils_pb2.RelationMetadata: ...
882
- @property
883
- def facets(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
884
- def __init__(
885
- self,
886
- *,
887
- source: builtins.int = ...,
888
- relation: builtins.int = ...,
889
- destination: builtins.int = ...,
890
- metadata: nucliadb_protos.utils_pb2.RelationMetadata | None = ...,
891
- resource_field_id: builtins.str | None = ...,
892
- facets: collections.abc.Iterable[builtins.str] | None = ...,
893
- ) -> None: ...
894
- def HasField(self, field_name: typing.Literal["_metadata", b"_metadata", "_resource_field_id", b"_resource_field_id", "metadata", b"metadata", "resource_field_id", b"resource_field_id"]) -> builtins.bool: ...
895
- def ClearField(self, field_name: typing.Literal["_metadata", b"_metadata", "_resource_field_id", b"_resource_field_id", "destination", b"destination", "facets", b"facets", "metadata", b"metadata", "relation", b"relation", "resource_field_id", b"resource_field_id", "source", b"source"]) -> None: ...
896
- @typing.overload
897
- def WhichOneof(self, oneof_group: typing.Literal["_metadata", b"_metadata"]) -> typing.Literal["metadata"] | None: ...
898
- @typing.overload
899
- def WhichOneof(self, oneof_group: typing.Literal["_resource_field_id", b"_resource_field_id"]) -> typing.Literal["resource_field_id"] | None: ...
900
-
901
- NODES_FIELD_NUMBER: builtins.int
902
- RELATIONS_FIELD_NUMBER: builtins.int
903
- GRAPH_FIELD_NUMBER: builtins.int
904
- @property
905
- def nodes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.utils_pb2.RelationNode]: ...
906
- @property
907
- def relations(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphSearchResponse.Relation]: ...
908
- @property
909
- def graph(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphSearchResponse.Path]: ...
910
- def __init__(
911
- self,
912
- *,
913
- nodes: collections.abc.Iterable[nucliadb_protos.utils_pb2.RelationNode] | None = ...,
914
- relations: collections.abc.Iterable[global___GraphSearchResponse.Relation] | None = ...,
915
- graph: collections.abc.Iterable[global___GraphSearchResponse.Path] | None = ...,
916
- ) -> None: ...
917
- def ClearField(self, field_name: typing.Literal["graph", b"graph", "nodes", b"nodes", "relations", b"relations"]) -> None: ...
918
-
919
- global___GraphSearchResponse = GraphSearchResponse
920
-
921
- @typing.final
922
- class FilterExpression(google.protobuf.message.Message):
923
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
924
-
925
- @typing.final
926
- class FilterExpressionList(google.protobuf.message.Message):
927
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
928
-
929
- OPERANDS_FIELD_NUMBER: builtins.int
930
- @property
931
- def operands(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FilterExpression]: ...
932
- def __init__(
933
- self,
934
- *,
935
- operands: collections.abc.Iterable[global___FilterExpression] | None = ...,
936
- ) -> None: ...
937
- def ClearField(self, field_name: typing.Literal["operands", b"operands"]) -> None: ...
938
-
939
- @typing.final
940
- class ResourceFilter(google.protobuf.message.Message):
941
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
942
-
943
- RESOURCE_ID_FIELD_NUMBER: builtins.int
944
- resource_id: builtins.str
945
- def __init__(
946
- self,
947
- *,
948
- resource_id: builtins.str = ...,
949
- ) -> None: ...
950
- def ClearField(self, field_name: typing.Literal["resource_id", b"resource_id"]) -> None: ...
951
-
952
- @typing.final
953
- class FieldFilter(google.protobuf.message.Message):
954
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
955
-
956
- FIELD_TYPE_FIELD_NUMBER: builtins.int
957
- FIELD_ID_FIELD_NUMBER: builtins.int
958
- field_type: builtins.str
959
- field_id: builtins.str
960
- def __init__(
961
- self,
962
- *,
963
- field_type: builtins.str = ...,
964
- field_id: builtins.str | None = ...,
965
- ) -> None: ...
966
- def HasField(self, field_name: typing.Literal["_field_id", b"_field_id", "field_id", b"field_id"]) -> builtins.bool: ...
967
- def ClearField(self, field_name: typing.Literal["_field_id", b"_field_id", "field_id", b"field_id", "field_type", b"field_type"]) -> None: ...
968
- def WhichOneof(self, oneof_group: typing.Literal["_field_id", b"_field_id"]) -> typing.Literal["field_id"] | None: ...
969
-
970
- @typing.final
971
- class DateRangeFilter(google.protobuf.message.Message):
972
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
973
-
974
- class _DateField:
975
- ValueType = typing.NewType("ValueType", builtins.int)
976
- V: typing_extensions.TypeAlias = ValueType
977
-
978
- class _DateFieldEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[FilterExpression.DateRangeFilter._DateField.ValueType], builtins.type):
979
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
980
- CREATED: FilterExpression.DateRangeFilter._DateField.ValueType # 0
981
- MODIFIED: FilterExpression.DateRangeFilter._DateField.ValueType # 1
982
-
983
- class DateField(_DateField, metaclass=_DateFieldEnumTypeWrapper): ...
984
- CREATED: FilterExpression.DateRangeFilter.DateField.ValueType # 0
985
- MODIFIED: FilterExpression.DateRangeFilter.DateField.ValueType # 1
986
-
987
- FIELD_FIELD_NUMBER: builtins.int
988
- SINCE_FIELD_NUMBER: builtins.int
989
- UNTIL_FIELD_NUMBER: builtins.int
990
- field: global___FilterExpression.DateRangeFilter.DateField.ValueType
991
- @property
992
- def since(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
993
- @property
994
- def until(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
995
- def __init__(
996
- self,
997
- *,
998
- field: global___FilterExpression.DateRangeFilter.DateField.ValueType = ...,
999
- since: google.protobuf.timestamp_pb2.Timestamp | None = ...,
1000
- until: google.protobuf.timestamp_pb2.Timestamp | None = ...,
1001
- ) -> None: ...
1002
- def HasField(self, field_name: typing.Literal["_since", b"_since", "_until", b"_until", "since", b"since", "until", b"until"]) -> builtins.bool: ...
1003
- def ClearField(self, field_name: typing.Literal["_since", b"_since", "_until", b"_until", "field", b"field", "since", b"since", "until", b"until"]) -> None: ...
1004
- @typing.overload
1005
- def WhichOneof(self, oneof_group: typing.Literal["_since", b"_since"]) -> typing.Literal["since"] | None: ...
1006
- @typing.overload
1007
- def WhichOneof(self, oneof_group: typing.Literal["_until", b"_until"]) -> typing.Literal["until"] | None: ...
1008
-
1009
- @typing.final
1010
- class KeywordFilter(google.protobuf.message.Message):
1011
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1012
-
1013
- KEYWORD_FIELD_NUMBER: builtins.int
1014
- keyword: builtins.str
1015
- def __init__(
1016
- self,
1017
- *,
1018
- keyword: builtins.str = ...,
1019
- ) -> None: ...
1020
- def ClearField(self, field_name: typing.Literal["keyword", b"keyword"]) -> None: ...
1021
-
1022
- @typing.final
1023
- class FacetFilter(google.protobuf.message.Message):
1024
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1025
-
1026
- FACET_FIELD_NUMBER: builtins.int
1027
- facet: builtins.str
1028
- def __init__(
1029
- self,
1030
- *,
1031
- facet: builtins.str = ...,
1032
- ) -> None: ...
1033
- def ClearField(self, field_name: typing.Literal["facet", b"facet"]) -> None: ...
1034
-
1035
- BOOL_AND_FIELD_NUMBER: builtins.int
1036
- BOOL_OR_FIELD_NUMBER: builtins.int
1037
- BOOL_NOT_FIELD_NUMBER: builtins.int
1038
- RESOURCE_FIELD_NUMBER: builtins.int
1039
- FIELD_FIELD_NUMBER: builtins.int
1040
- KEYWORD_FIELD_NUMBER: builtins.int
1041
- DATE_FIELD_NUMBER: builtins.int
1042
- FACET_FIELD_NUMBER: builtins.int
1043
- @property
1044
- def bool_and(self) -> global___FilterExpression.FilterExpressionList: ...
1045
- @property
1046
- def bool_or(self) -> global___FilterExpression.FilterExpressionList: ...
1047
- @property
1048
- def bool_not(self) -> global___FilterExpression: ...
1049
- @property
1050
- def resource(self) -> global___FilterExpression.ResourceFilter: ...
1051
- @property
1052
- def field(self) -> global___FilterExpression.FieldFilter: ...
1053
- @property
1054
- def keyword(self) -> global___FilterExpression.KeywordFilter: ...
1055
- @property
1056
- def date(self) -> global___FilterExpression.DateRangeFilter: ...
1057
- @property
1058
- def facet(self) -> global___FilterExpression.FacetFilter: ...
1059
- def __init__(
1060
- self,
1061
- *,
1062
- bool_and: global___FilterExpression.FilterExpressionList | None = ...,
1063
- bool_or: global___FilterExpression.FilterExpressionList | None = ...,
1064
- bool_not: global___FilterExpression | None = ...,
1065
- resource: global___FilterExpression.ResourceFilter | None = ...,
1066
- field: global___FilterExpression.FieldFilter | None = ...,
1067
- keyword: global___FilterExpression.KeywordFilter | None = ...,
1068
- date: global___FilterExpression.DateRangeFilter | None = ...,
1069
- facet: global___FilterExpression.FacetFilter | None = ...,
1070
- ) -> None: ...
1071
- def HasField(self, field_name: typing.Literal["bool_and", b"bool_and", "bool_not", b"bool_not", "bool_or", b"bool_or", "date", b"date", "expr", b"expr", "facet", b"facet", "field", b"field", "keyword", b"keyword", "resource", b"resource"]) -> builtins.bool: ...
1072
- def ClearField(self, field_name: typing.Literal["bool_and", b"bool_and", "bool_not", b"bool_not", "bool_or", b"bool_or", "date", b"date", "expr", b"expr", "facet", b"facet", "field", b"field", "keyword", b"keyword", "resource", b"resource"]) -> None: ...
1073
- def WhichOneof(self, oneof_group: typing.Literal["expr", b"expr"]) -> typing.Literal["bool_and", "bool_or", "bool_not", "resource", "field", "keyword", "date", "facet"] | None: ...
1074
-
1075
- global___FilterExpression = FilterExpression
1076
-
1077
- @typing.final
1078
- class SearchRequest(google.protobuf.message.Message):
1079
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1080
-
1081
- @typing.final
1082
- class GraphSearch(google.protobuf.message.Message):
1083
- """Reduced graph search for specific use case of text block search. It only
1084
- supports path search (as it's the only one that can return paragraph_ids)
1085
- and filters are inherited from the main request
1086
- """
1087
-
1088
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1089
-
1090
- QUERY_FIELD_NUMBER: builtins.int
1091
- @property
1092
- def query(self) -> global___GraphQuery: ...
1093
- def __init__(
1094
- self,
1095
- *,
1096
- query: global___GraphQuery | None = ...,
1097
- ) -> None: ...
1098
- def HasField(self, field_name: typing.Literal["query", b"query"]) -> builtins.bool: ...
1099
- def ClearField(self, field_name: typing.Literal["query", b"query"]) -> None: ...
1100
-
1101
- SHARD_FIELD_NUMBER: builtins.int
1102
- BODY_FIELD_NUMBER: builtins.int
1103
- ORDER_FIELD_NUMBER: builtins.int
1104
- FACETED_FIELD_NUMBER: builtins.int
1105
- PAGE_NUMBER_FIELD_NUMBER: builtins.int
1106
- RESULT_PER_PAGE_FIELD_NUMBER: builtins.int
1107
- VECTOR_FIELD_NUMBER: builtins.int
1108
- VECTORSET_FIELD_NUMBER: builtins.int
1109
- PARAGRAPH_FIELD_NUMBER: builtins.int
1110
- DOCUMENT_FIELD_NUMBER: builtins.int
1111
- WITH_DUPLICATES_FIELD_NUMBER: builtins.int
1112
- ONLY_FACETED_FIELD_NUMBER: builtins.int
1113
- ADVANCED_QUERY_FIELD_NUMBER: builtins.int
1114
- MIN_SCORE_SEMANTIC_FIELD_NUMBER: builtins.int
1115
- MIN_SCORE_BM25_FIELD_NUMBER: builtins.int
1116
- SECURITY_FIELD_NUMBER: builtins.int
1117
- FIELD_FILTER_FIELD_NUMBER: builtins.int
1118
- PARAGRAPH_FILTER_FIELD_NUMBER: builtins.int
1119
- FILTER_OPERATOR_FIELD_NUMBER: builtins.int
1120
- GRAPH_SEARCH_FIELD_NUMBER: builtins.int
1121
- shard: builtins.str
1122
- body: builtins.str
1123
- """query this text in all the paragraphs"""
1124
- page_number: builtins.int
1125
- result_per_page: builtins.int
1126
- vectorset: builtins.str
1127
- paragraph: builtins.bool
1128
- document: builtins.bool
1129
- with_duplicates: builtins.bool
1130
- only_faceted: builtins.bool
1131
- advanced_query: builtins.str
1132
- min_score_semantic: builtins.float
1133
- min_score_bm25: builtins.float
1134
- filter_operator: global___FilterOperator.ValueType
1135
- @property
1136
- def order(self) -> global___OrderBy: ...
1137
- @property
1138
- def faceted(self) -> global___Faceted: ...
1139
- @property
1140
- def vector(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]:
1141
- """Embedded vector search."""
1142
-
1143
- @property
1144
- def security(self) -> nucliadb_protos.utils_pb2.Security: ...
1145
- @property
1146
- def field_filter(self) -> global___FilterExpression: ...
1147
- @property
1148
- def paragraph_filter(self) -> global___FilterExpression: ...
1149
- @property
1150
- def graph_search(self) -> global___SearchRequest.GraphSearch: ...
1151
- def __init__(
1152
- self,
1153
- *,
1154
- shard: builtins.str = ...,
1155
- body: builtins.str = ...,
1156
- order: global___OrderBy | None = ...,
1157
- faceted: global___Faceted | None = ...,
1158
- page_number: builtins.int = ...,
1159
- result_per_page: builtins.int = ...,
1160
- vector: collections.abc.Iterable[builtins.float] | None = ...,
1161
- vectorset: builtins.str = ...,
1162
- paragraph: builtins.bool = ...,
1163
- document: builtins.bool = ...,
1164
- with_duplicates: builtins.bool = ...,
1165
- only_faceted: builtins.bool = ...,
1166
- advanced_query: builtins.str | None = ...,
1167
- min_score_semantic: builtins.float = ...,
1168
- min_score_bm25: builtins.float = ...,
1169
- security: nucliadb_protos.utils_pb2.Security | None = ...,
1170
- field_filter: global___FilterExpression | None = ...,
1171
- paragraph_filter: global___FilterExpression | None = ...,
1172
- filter_operator: global___FilterOperator.ValueType = ...,
1173
- graph_search: global___SearchRequest.GraphSearch | None = ...,
1174
- ) -> None: ...
1175
- def HasField(self, field_name: typing.Literal["_advanced_query", b"_advanced_query", "_field_filter", b"_field_filter", "_paragraph_filter", b"_paragraph_filter", "_security", b"_security", "advanced_query", b"advanced_query", "faceted", b"faceted", "field_filter", b"field_filter", "graph_search", b"graph_search", "order", b"order", "paragraph_filter", b"paragraph_filter", "security", b"security"]) -> builtins.bool: ...
1176
- def ClearField(self, field_name: typing.Literal["_advanced_query", b"_advanced_query", "_field_filter", b"_field_filter", "_paragraph_filter", b"_paragraph_filter", "_security", b"_security", "advanced_query", b"advanced_query", "body", b"body", "document", b"document", "faceted", b"faceted", "field_filter", b"field_filter", "filter_operator", b"filter_operator", "graph_search", b"graph_search", "min_score_bm25", b"min_score_bm25", "min_score_semantic", b"min_score_semantic", "only_faceted", b"only_faceted", "order", b"order", "page_number", b"page_number", "paragraph", b"paragraph", "paragraph_filter", b"paragraph_filter", "result_per_page", b"result_per_page", "security", b"security", "shard", b"shard", "vector", b"vector", "vectorset", b"vectorset", "with_duplicates", b"with_duplicates"]) -> None: ...
1177
- @typing.overload
1178
- def WhichOneof(self, oneof_group: typing.Literal["_advanced_query", b"_advanced_query"]) -> typing.Literal["advanced_query"] | None: ...
1179
- @typing.overload
1180
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
1181
- @typing.overload
1182
- def WhichOneof(self, oneof_group: typing.Literal["_paragraph_filter", b"_paragraph_filter"]) -> typing.Literal["paragraph_filter"] | None: ...
1183
- @typing.overload
1184
- def WhichOneof(self, oneof_group: typing.Literal["_security", b"_security"]) -> typing.Literal["security"] | None: ...
1185
-
1186
- global___SearchRequest = SearchRequest
1187
-
1188
- @typing.final
1189
- class SuggestRequest(google.protobuf.message.Message):
1190
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1191
-
1192
- SHARD_FIELD_NUMBER: builtins.int
1193
- BODY_FIELD_NUMBER: builtins.int
1194
- FEATURES_FIELD_NUMBER: builtins.int
1195
- FIELD_FILTER_FIELD_NUMBER: builtins.int
1196
- PARAGRAPH_FILTER_FIELD_NUMBER: builtins.int
1197
- FILTER_OPERATOR_FIELD_NUMBER: builtins.int
1198
- shard: builtins.str
1199
- body: builtins.str
1200
- filter_operator: global___FilterOperator.ValueType
1201
- @property
1202
- def features(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___SuggestFeatures.ValueType]: ...
1203
- @property
1204
- def field_filter(self) -> global___FilterExpression: ...
1205
- @property
1206
- def paragraph_filter(self) -> global___FilterExpression: ...
1207
- def __init__(
1208
- self,
1209
- *,
1210
- shard: builtins.str = ...,
1211
- body: builtins.str = ...,
1212
- features: collections.abc.Iterable[global___SuggestFeatures.ValueType] | None = ...,
1213
- field_filter: global___FilterExpression | None = ...,
1214
- paragraph_filter: global___FilterExpression | None = ...,
1215
- filter_operator: global___FilterOperator.ValueType = ...,
1216
- ) -> None: ...
1217
- def HasField(self, field_name: typing.Literal["_field_filter", b"_field_filter", "_paragraph_filter", b"_paragraph_filter", "field_filter", b"field_filter", "paragraph_filter", b"paragraph_filter"]) -> builtins.bool: ...
1218
- def ClearField(self, field_name: typing.Literal["_field_filter", b"_field_filter", "_paragraph_filter", b"_paragraph_filter", "body", b"body", "features", b"features", "field_filter", b"field_filter", "filter_operator", b"filter_operator", "paragraph_filter", b"paragraph_filter", "shard", b"shard"]) -> None: ...
1219
- @typing.overload
1220
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
1221
- @typing.overload
1222
- def WhichOneof(self, oneof_group: typing.Literal["_paragraph_filter", b"_paragraph_filter"]) -> typing.Literal["paragraph_filter"] | None: ...
1223
-
1224
- global___SuggestRequest = SuggestRequest
1225
-
1226
- @typing.final
1227
- class RelatedEntities(google.protobuf.message.Message):
1228
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1229
-
1230
- ENTITIES_FIELD_NUMBER: builtins.int
1231
- TOTAL_FIELD_NUMBER: builtins.int
1232
- total: builtins.int
1233
- @property
1234
- def entities(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1235
- def __init__(
1236
- self,
1237
- *,
1238
- entities: collections.abc.Iterable[builtins.str] | None = ...,
1239
- total: builtins.int = ...,
1240
- ) -> None: ...
1241
- def ClearField(self, field_name: typing.Literal["entities", b"entities", "total", b"total"]) -> None: ...
1242
-
1243
- global___RelatedEntities = RelatedEntities
1244
-
1245
- @typing.final
1246
- class SuggestResponse(google.protobuf.message.Message):
1247
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1248
-
1249
- TOTAL_FIELD_NUMBER: builtins.int
1250
- RESULTS_FIELD_NUMBER: builtins.int
1251
- QUERY_FIELD_NUMBER: builtins.int
1252
- EMATCHES_FIELD_NUMBER: builtins.int
1253
- ENTITY_RESULTS_FIELD_NUMBER: builtins.int
1254
- total: builtins.int
1255
- query: builtins.str
1256
- """The text that lead to this results"""
1257
- @property
1258
- def results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ParagraphResult]: ...
1259
- @property
1260
- def ematches(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1261
- @property
1262
- def entity_results(self) -> global___RelationPrefixSearchResponse:
1263
- """Entities related with the query"""
1264
-
1265
- def __init__(
1266
- self,
1267
- *,
1268
- total: builtins.int = ...,
1269
- results: collections.abc.Iterable[global___ParagraphResult] | None = ...,
1270
- query: builtins.str = ...,
1271
- ematches: collections.abc.Iterable[builtins.str] | None = ...,
1272
- entity_results: global___RelationPrefixSearchResponse | None = ...,
1273
- ) -> None: ...
1274
- def HasField(self, field_name: typing.Literal["entity_results", b"entity_results"]) -> builtins.bool: ...
1275
- def ClearField(self, field_name: typing.Literal["ematches", b"ematches", "entity_results", b"entity_results", "query", b"query", "results", b"results", "total", b"total"]) -> None: ...
1276
-
1277
- global___SuggestResponse = SuggestResponse
1278
-
1279
- @typing.final
1280
- class SearchResponse(google.protobuf.message.Message):
1281
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1282
-
1283
- DOCUMENT_FIELD_NUMBER: builtins.int
1284
- PARAGRAPH_FIELD_NUMBER: builtins.int
1285
- VECTOR_FIELD_NUMBER: builtins.int
1286
- GRAPH_FIELD_NUMBER: builtins.int
1287
- @property
1288
- def document(self) -> global___DocumentSearchResponse: ...
1289
- @property
1290
- def paragraph(self) -> global___ParagraphSearchResponse: ...
1291
- @property
1292
- def vector(self) -> global___VectorSearchResponse: ...
1293
- @property
1294
- def graph(self) -> global___GraphSearchResponse: ...
1295
- def __init__(
1296
- self,
1297
- *,
1298
- document: global___DocumentSearchResponse | None = ...,
1299
- paragraph: global___ParagraphSearchResponse | None = ...,
1300
- vector: global___VectorSearchResponse | None = ...,
1301
- graph: global___GraphSearchResponse | None = ...,
1302
- ) -> None: ...
1303
- def HasField(self, field_name: typing.Literal["document", b"document", "graph", b"graph", "paragraph", b"paragraph", "vector", b"vector"]) -> builtins.bool: ...
1304
- def ClearField(self, field_name: typing.Literal["document", b"document", "graph", b"graph", "paragraph", b"paragraph", "vector", b"vector"]) -> None: ...
1305
-
1306
- global___SearchResponse = SearchResponse
1307
-
1308
- @typing.final
1309
- class IdCollection(google.protobuf.message.Message):
1310
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1311
-
1312
- IDS_FIELD_NUMBER: builtins.int
1313
- @property
1314
- def ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1315
- def __init__(
1316
- self,
1317
- *,
1318
- ids: collections.abc.Iterable[builtins.str] | None = ...,
1319
- ) -> None: ...
1320
- def ClearField(self, field_name: typing.Literal["ids", b"ids"]) -> None: ...
1321
-
1322
- global___IdCollection = IdCollection
1323
-
1324
- @typing.final
1325
- class RelationEdge(google.protobuf.message.Message):
1326
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1327
-
1328
- EDGE_TYPE_FIELD_NUMBER: builtins.int
1329
- PROPERTY_FIELD_NUMBER: builtins.int
1330
- edge_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
1331
- property: builtins.str
1332
- def __init__(
1333
- self,
1334
- *,
1335
- edge_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType = ...,
1336
- property: builtins.str = ...,
1337
- ) -> None: ...
1338
- def ClearField(self, field_name: typing.Literal["edge_type", b"edge_type", "property", b"property"]) -> None: ...
1339
-
1340
- global___RelationEdge = RelationEdge
1341
-
1342
- @typing.final
1343
- class EdgeList(google.protobuf.message.Message):
1344
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1345
-
1346
- LIST_FIELD_NUMBER: builtins.int
1347
- @property
1348
- def list(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelationEdge]: ...
1349
- def __init__(
1350
- self,
1351
- *,
1352
- list: collections.abc.Iterable[global___RelationEdge] | None = ...,
1353
- ) -> None: ...
1354
- def ClearField(self, field_name: typing.Literal["list", b"list"]) -> None: ...
1355
-
1356
- global___EdgeList = EdgeList
1357
-
1358
- @typing.final
1359
- class GetShardRequest(google.protobuf.message.Message):
1360
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1361
-
1362
- SHARD_ID_FIELD_NUMBER: builtins.int
1363
- VECTORSET_FIELD_NUMBER: builtins.int
1364
- vectorset: builtins.str
1365
- @property
1366
- def shard_id(self) -> nucliadb_protos.noderesources_pb2.ShardId: ...
1367
- def __init__(
1368
- self,
1369
- *,
1370
- shard_id: nucliadb_protos.noderesources_pb2.ShardId | None = ...,
1371
- vectorset: builtins.str = ...,
1372
- ) -> None: ...
1373
- def HasField(self, field_name: typing.Literal["shard_id", b"shard_id"]) -> builtins.bool: ...
1374
- def ClearField(self, field_name: typing.Literal["shard_id", b"shard_id", "vectorset", b"vectorset"]) -> None: ...
1375
-
1376
- global___GetShardRequest = GetShardRequest
1377
-
1378
- @typing.final
1379
- class ParagraphItem(google.protobuf.message.Message):
1380
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1381
-
1382
- ID_FIELD_NUMBER: builtins.int
1383
- LABELS_FIELD_NUMBER: builtins.int
1384
- id: builtins.str
1385
- @property
1386
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1387
- def __init__(
1388
- self,
1389
- *,
1390
- id: builtins.str = ...,
1391
- labels: collections.abc.Iterable[builtins.str] | None = ...,
1392
- ) -> None: ...
1393
- def ClearField(self, field_name: typing.Literal["id", b"id", "labels", b"labels"]) -> None: ...
1394
-
1395
- global___ParagraphItem = ParagraphItem
1396
-
1397
- @typing.final
1398
- class DocumentItem(google.protobuf.message.Message):
1399
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1400
-
1401
- UUID_FIELD_NUMBER: builtins.int
1402
- FIELD_FIELD_NUMBER: builtins.int
1403
- LABELS_FIELD_NUMBER: builtins.int
1404
- uuid: builtins.str
1405
- field: builtins.str
1406
- @property
1407
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1408
- def __init__(
1409
- self,
1410
- *,
1411
- uuid: builtins.str = ...,
1412
- field: builtins.str = ...,
1413
- labels: collections.abc.Iterable[builtins.str] | None = ...,
1414
- ) -> None: ...
1415
- def ClearField(self, field_name: typing.Literal["field", b"field", "labels", b"labels", "uuid", b"uuid"]) -> None: ...
1416
-
1417
- global___DocumentItem = DocumentItem
1418
-
1419
- @typing.final
1420
- class StreamRequest(google.protobuf.message.Message):
1421
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1422
-
1423
- SHARD_ID_FIELD_NUMBER: builtins.int
1424
- FILTER_FIELD_NUMBER: builtins.int
1425
- @property
1426
- def shard_id(self) -> nucliadb_protos.noderesources_pb2.ShardId: ...
1427
- @property
1428
- def filter(self) -> global___StreamFilter: ...
1429
- def __init__(
1430
- self,
1431
- *,
1432
- shard_id: nucliadb_protos.noderesources_pb2.ShardId | None = ...,
1433
- filter: global___StreamFilter | None = ...,
1434
- ) -> None: ...
1435
- def HasField(self, field_name: typing.Literal["filter", b"filter", "shard_id", b"shard_id"]) -> builtins.bool: ...
1436
- def ClearField(self, field_name: typing.Literal["filter", b"filter", "shard_id", b"shard_id"]) -> None: ...
1437
-
1438
- global___StreamRequest = StreamRequest
1439
-
1440
- @typing.final
1441
- class GetShardFilesRequest(google.protobuf.message.Message):
1442
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1443
-
1444
- SHARD_ID_FIELD_NUMBER: builtins.int
1445
- shard_id: builtins.str
1446
- def __init__(
1447
- self,
1448
- *,
1449
- shard_id: builtins.str = ...,
1450
- ) -> None: ...
1451
- def ClearField(self, field_name: typing.Literal["shard_id", b"shard_id"]) -> None: ...
1452
-
1453
- global___GetShardFilesRequest = GetShardFilesRequest
1454
-
1455
- @typing.final
1456
- class ShardFileList(google.protobuf.message.Message):
1457
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1458
-
1459
- FILES_FIELD_NUMBER: builtins.int
1460
- @property
1461
- def files(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ShardFile]: ...
1462
- def __init__(
1463
- self,
1464
- *,
1465
- files: collections.abc.Iterable[global___ShardFile] | None = ...,
1466
- ) -> None: ...
1467
- def ClearField(self, field_name: typing.Literal["files", b"files"]) -> None: ...
1468
-
1469
- global___ShardFileList = ShardFileList
1470
-
1471
- @typing.final
1472
- class ShardFile(google.protobuf.message.Message):
1473
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1474
-
1475
- RELATIVE_PATH_FIELD_NUMBER: builtins.int
1476
- SIZE_FIELD_NUMBER: builtins.int
1477
- relative_path: builtins.str
1478
- size: builtins.int
1479
- def __init__(
1480
- self,
1481
- *,
1482
- relative_path: builtins.str = ...,
1483
- size: builtins.int = ...,
1484
- ) -> None: ...
1485
- def ClearField(self, field_name: typing.Literal["relative_path", b"relative_path", "size", b"size"]) -> None: ...
1486
-
1487
- global___ShardFile = ShardFile
1488
-
1489
- @typing.final
1490
- class DownloadShardFileRequest(google.protobuf.message.Message):
1491
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1492
-
1493
- SHARD_ID_FIELD_NUMBER: builtins.int
1494
- RELATIVE_PATH_FIELD_NUMBER: builtins.int
1495
- shard_id: builtins.str
1496
- relative_path: builtins.str
1497
- def __init__(
1498
- self,
1499
- *,
1500
- shard_id: builtins.str = ...,
1501
- relative_path: builtins.str = ...,
1502
- ) -> None: ...
1503
- def ClearField(self, field_name: typing.Literal["relative_path", b"relative_path", "shard_id", b"shard_id"]) -> None: ...
1504
-
1505
- global___DownloadShardFileRequest = DownloadShardFileRequest
1506
-
1507
- @typing.final
1508
- class ShardFileChunk(google.protobuf.message.Message):
1509
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1510
-
1511
- DATA_FIELD_NUMBER: builtins.int
1512
- INDEX_FIELD_NUMBER: builtins.int
1513
- data: builtins.bytes
1514
- index: builtins.int
1515
- def __init__(
1516
- self,
1517
- *,
1518
- data: builtins.bytes = ...,
1519
- index: builtins.int = ...,
1520
- ) -> None: ...
1521
- def ClearField(self, field_name: typing.Literal["data", b"data", "index", b"index"]) -> None: ...
1522
-
1523
- global___ShardFileChunk = ShardFileChunk