nucliadb-protos 6.3.6.post4063__py3-none-any.whl → 6.10.0.post5705__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.

Potentially problematic release.


This version of nucliadb-protos might be problematic. Click here for more details.

Files changed (44) hide show
  1. .gitignore +1 -0
  2. build.py +56 -0
  3. nucliadb_protos/audit_pb2.py +43 -46
  4. nucliadb_protos/audit_pb2.pyi +64 -13
  5. nucliadb_protos/backups_pb2.py +13 -3
  6. nucliadb_protos/backups_pb2_grpc.py +20 -0
  7. nucliadb_protos/dataset_pb2.py +13 -3
  8. nucliadb_protos/dataset_pb2.pyi +3 -0
  9. nucliadb_protos/kb_usage_pb2.py +20 -10
  10. nucliadb_protos/kb_usage_pb2.pyi +2 -0
  11. nucliadb_protos/knowledgebox_pb2.py +116 -114
  12. nucliadb_protos/knowledgebox_pb2.pyi +49 -28
  13. nucliadb_protos/migrations_pb2.py +13 -3
  14. nucliadb_protos/resources_pb2.py +239 -219
  15. nucliadb_protos/resources_pb2.pyi +100 -15
  16. nucliadb_protos/standalone_pb2.py +13 -3
  17. nucliadb_protos/standalone_pb2_grpc.py +49 -8
  18. nucliadb_protos/train_pb2.py +18 -40
  19. nucliadb_protos/train_pb2.pyi +6 -8
  20. nucliadb_protos/train_pb2_grpc.py +133 -32
  21. nucliadb_protos/train_pb2_grpc.pyi +6 -8
  22. nucliadb_protos/utils_pb2.py +18 -10
  23. nucliadb_protos/utils_pb2.pyi +0 -15
  24. nucliadb_protos/writer_pb2.py +140 -176
  25. nucliadb_protos/writer_pb2.pyi +40 -311
  26. nucliadb_protos/writer_pb2_grpc.py +204 -185
  27. nucliadb_protos/writer_pb2_grpc.pyi +11 -99
  28. {nucliadb_protos-6.3.6.post4063.dist-info → nucliadb_protos-6.10.0.post5705.dist-info}/METADATA +10 -10
  29. nucliadb_protos-6.10.0.post5705.dist-info/RECORD +37 -0
  30. {nucliadb_protos-6.3.6.post4063.dist-info → nucliadb_protos-6.10.0.post5705.dist-info}/WHEEL +1 -2
  31. nucliadb_protos-6.10.0.post5705.dist-info/entry_points.txt +4 -0
  32. nucliadb_protos/__init__.py +0 -0
  33. nucliadb_protos/nodereader_pb2.py +0 -187
  34. nucliadb_protos/nodereader_pb2.pyi +0 -1715
  35. nucliadb_protos/nodereader_pb2_grpc.py +0 -438
  36. nucliadb_protos/nodereader_pb2_grpc.pyi +0 -288
  37. nucliadb_protos/noderesources_pb2.py +0 -145
  38. nucliadb_protos/noderesources_pb2.pyi +0 -993
  39. nucliadb_protos/nodewriter_pb2.py +0 -80
  40. nucliadb_protos/nodewriter_pb2.pyi +0 -348
  41. nucliadb_protos/nodewriter_pb2_grpc.py +0 -430
  42. nucliadb_protos/nodewriter_pb2_grpc.pyi +0 -256
  43. nucliadb_protos-6.3.6.post4063.dist-info/RECORD +0 -46
  44. nucliadb_protos-6.3.6.post4063.dist-info/top_level.txt +0 -1
@@ -1,1715 +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 RelationNodeFilter(google.protobuf.message.Message):
531
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
532
-
533
- NODE_TYPE_FIELD_NUMBER: builtins.int
534
- NODE_SUBTYPE_FIELD_NUMBER: builtins.int
535
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType
536
- node_subtype: builtins.str
537
- def __init__(
538
- self,
539
- *,
540
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType = ...,
541
- node_subtype: builtins.str | None = ...,
542
- ) -> None: ...
543
- def HasField(self, field_name: typing.Literal["_node_subtype", b"_node_subtype", "node_subtype", b"node_subtype"]) -> builtins.bool: ...
544
- def ClearField(self, field_name: typing.Literal["_node_subtype", b"_node_subtype", "node_subtype", b"node_subtype", "node_type", b"node_type"]) -> None: ...
545
- def WhichOneof(self, oneof_group: typing.Literal["_node_subtype", b"_node_subtype"]) -> typing.Literal["node_subtype"] | None: ...
546
-
547
- global___RelationNodeFilter = RelationNodeFilter
548
-
549
- @typing.final
550
- class RelationEdgeFilter(google.protobuf.message.Message):
551
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
552
-
553
- RELATION_TYPE_FIELD_NUMBER: builtins.int
554
- RELATION_SUBTYPE_FIELD_NUMBER: builtins.int
555
- RELATION_VALUE_FIELD_NUMBER: builtins.int
556
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
557
- """Will filter the search to edges of type ntype."""
558
- relation_subtype: builtins.str
559
- @property
560
- def relation_value(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
561
- def __init__(
562
- self,
563
- *,
564
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType = ...,
565
- relation_subtype: builtins.str | None = ...,
566
- relation_value: collections.abc.Iterable[builtins.str] | None = ...,
567
- ) -> None: ...
568
- def HasField(self, field_name: typing.Literal["_relation_subtype", b"_relation_subtype", "relation_subtype", b"relation_subtype"]) -> builtins.bool: ...
569
- def ClearField(self, field_name: typing.Literal["_relation_subtype", b"_relation_subtype", "relation_subtype", b"relation_subtype", "relation_type", b"relation_type", "relation_value", b"relation_value"]) -> None: ...
570
- def WhichOneof(self, oneof_group: typing.Literal["_relation_subtype", b"_relation_subtype"]) -> typing.Literal["relation_subtype"] | None: ...
571
-
572
- global___RelationEdgeFilter = RelationEdgeFilter
573
-
574
- @typing.final
575
- class RelationPrefixSearchRequest(google.protobuf.message.Message):
576
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
577
-
578
- PREFIX_FIELD_NUMBER: builtins.int
579
- QUERY_FIELD_NUMBER: builtins.int
580
- NODE_FILTERS_FIELD_NUMBER: builtins.int
581
- prefix: builtins.str
582
- """Search for a single prefix"""
583
- query: builtins.str
584
- """Search for entities appearing on a query"""
585
- @property
586
- def node_filters(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelationNodeFilter]: ...
587
- def __init__(
588
- self,
589
- *,
590
- prefix: builtins.str = ...,
591
- query: builtins.str = ...,
592
- node_filters: collections.abc.Iterable[global___RelationNodeFilter] | None = ...,
593
- ) -> None: ...
594
- def HasField(self, field_name: typing.Literal["prefix", b"prefix", "query", b"query", "search", b"search"]) -> builtins.bool: ...
595
- def ClearField(self, field_name: typing.Literal["node_filters", b"node_filters", "prefix", b"prefix", "query", b"query", "search", b"search"]) -> None: ...
596
- def WhichOneof(self, oneof_group: typing.Literal["search", b"search"]) -> typing.Literal["prefix", "query"] | None: ...
597
-
598
- global___RelationPrefixSearchRequest = RelationPrefixSearchRequest
599
-
600
- @typing.final
601
- class RelationPrefixSearchResponse(google.protobuf.message.Message):
602
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
603
-
604
- NODES_FIELD_NUMBER: builtins.int
605
- @property
606
- def nodes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.utils_pb2.RelationNode]: ...
607
- def __init__(
608
- self,
609
- *,
610
- nodes: collections.abc.Iterable[nucliadb_protos.utils_pb2.RelationNode] | None = ...,
611
- ) -> None: ...
612
- def ClearField(self, field_name: typing.Literal["nodes", b"nodes"]) -> None: ...
613
-
614
- global___RelationPrefixSearchResponse = RelationPrefixSearchResponse
615
-
616
- @typing.final
617
- class EntitiesSubgraphRequest(google.protobuf.message.Message):
618
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
619
-
620
- @typing.final
621
- class DeletedEntities(google.protobuf.message.Message):
622
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
623
-
624
- NODE_SUBTYPE_FIELD_NUMBER: builtins.int
625
- NODE_VALUES_FIELD_NUMBER: builtins.int
626
- node_subtype: builtins.str
627
- @property
628
- def node_values(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
629
- def __init__(
630
- self,
631
- *,
632
- node_subtype: builtins.str = ...,
633
- node_values: collections.abc.Iterable[builtins.str] | None = ...,
634
- ) -> None: ...
635
- def ClearField(self, field_name: typing.Literal["node_subtype", b"node_subtype", "node_values", b"node_values"]) -> None: ...
636
-
637
- ENTRY_POINTS_FIELD_NUMBER: builtins.int
638
- DEPTH_FIELD_NUMBER: builtins.int
639
- DELETED_ENTITIES_FIELD_NUMBER: builtins.int
640
- DELETED_GROUPS_FIELD_NUMBER: builtins.int
641
- depth: builtins.int
642
- @property
643
- def entry_points(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.utils_pb2.RelationNode]:
644
- """List of vertices where search will trigger"""
645
-
646
- @property
647
- def deleted_entities(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___EntitiesSubgraphRequest.DeletedEntities]: ...
648
- @property
649
- def deleted_groups(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
650
- def __init__(
651
- self,
652
- *,
653
- entry_points: collections.abc.Iterable[nucliadb_protos.utils_pb2.RelationNode] | None = ...,
654
- depth: builtins.int | None = ...,
655
- deleted_entities: collections.abc.Iterable[global___EntitiesSubgraphRequest.DeletedEntities] | None = ...,
656
- deleted_groups: collections.abc.Iterable[builtins.str] | None = ...,
657
- ) -> None: ...
658
- def HasField(self, field_name: typing.Literal["_depth", b"_depth", "depth", b"depth"]) -> builtins.bool: ...
659
- def ClearField(self, field_name: typing.Literal["_depth", b"_depth", "deleted_entities", b"deleted_entities", "deleted_groups", b"deleted_groups", "depth", b"depth", "entry_points", b"entry_points"]) -> None: ...
660
- def WhichOneof(self, oneof_group: typing.Literal["_depth", b"_depth"]) -> typing.Literal["depth"] | None: ...
661
-
662
- global___EntitiesSubgraphRequest = EntitiesSubgraphRequest
663
-
664
- @typing.final
665
- class EntitiesSubgraphResponse(google.protobuf.message.Message):
666
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
667
-
668
- RELATIONS_FIELD_NUMBER: builtins.int
669
- @property
670
- def relations(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.noderesources_pb2.IndexRelation]: ...
671
- def __init__(
672
- self,
673
- *,
674
- relations: collections.abc.Iterable[nucliadb_protos.noderesources_pb2.IndexRelation] | None = ...,
675
- ) -> None: ...
676
- def ClearField(self, field_name: typing.Literal["relations", b"relations"]) -> None: ...
677
-
678
- global___EntitiesSubgraphResponse = EntitiesSubgraphResponse
679
-
680
- @typing.final
681
- class GraphQuery(google.protobuf.message.Message):
682
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
683
-
684
- @typing.final
685
- class Node(google.protobuf.message.Message):
686
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
687
-
688
- class _MatchKind:
689
- ValueType = typing.NewType("ValueType", builtins.int)
690
- V: typing_extensions.TypeAlias = ValueType
691
-
692
- class _MatchKindEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphQuery.Node._MatchKind.ValueType], builtins.type):
693
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
694
- DEPRECATED_EXACT: GraphQuery.Node._MatchKind.ValueType # 0
695
- DEPRECATED_FUZZY: GraphQuery.Node._MatchKind.ValueType # 1
696
-
697
- class MatchKind(_MatchKind, metaclass=_MatchKindEnumTypeWrapper): ...
698
- DEPRECATED_EXACT: GraphQuery.Node.MatchKind.ValueType # 0
699
- DEPRECATED_FUZZY: GraphQuery.Node.MatchKind.ValueType # 1
700
-
701
- class _MatchLocation:
702
- ValueType = typing.NewType("ValueType", builtins.int)
703
- V: typing_extensions.TypeAlias = ValueType
704
-
705
- class _MatchLocationEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphQuery.Node._MatchLocation.ValueType], builtins.type):
706
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
707
- FULL: GraphQuery.Node._MatchLocation.ValueType # 0
708
- """Match full value. Search "Rosa Parks" to find "Rosa Parks" """
709
- PREFIX: GraphQuery.Node._MatchLocation.ValueType # 1
710
- """Match prefix. Search "Rosa P" or "Ros" to find "Rosa Parks" """
711
- WORDS: GraphQuery.Node._MatchLocation.ValueType # 2
712
- """Match individual words. Search "Rosa" or "Parks" to find "Rosa Parks" """
713
- PREFIX_WORDS: GraphQuery.Node._MatchLocation.ValueType # 3
714
- """Match individual word by prefix. Search "Ros" or "Par" to find "Rosa Parks" """
715
-
716
- class MatchLocation(_MatchLocation, metaclass=_MatchLocationEnumTypeWrapper): ...
717
- FULL: GraphQuery.Node.MatchLocation.ValueType # 0
718
- """Match full value. Search "Rosa Parks" to find "Rosa Parks" """
719
- PREFIX: GraphQuery.Node.MatchLocation.ValueType # 1
720
- """Match prefix. Search "Rosa P" or "Ros" to find "Rosa Parks" """
721
- WORDS: GraphQuery.Node.MatchLocation.ValueType # 2
722
- """Match individual words. Search "Rosa" or "Parks" to find "Rosa Parks" """
723
- PREFIX_WORDS: GraphQuery.Node.MatchLocation.ValueType # 3
724
- """Match individual word by prefix. Search "Ros" or "Par" to find "Rosa Parks" """
725
-
726
- @typing.final
727
- class ExactMatch(google.protobuf.message.Message):
728
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
729
-
730
- KIND_FIELD_NUMBER: builtins.int
731
- kind: global___GraphQuery.Node.MatchLocation.ValueType
732
- def __init__(
733
- self,
734
- *,
735
- kind: global___GraphQuery.Node.MatchLocation.ValueType = ...,
736
- ) -> None: ...
737
- def ClearField(self, field_name: typing.Literal["kind", b"kind"]) -> None: ...
738
-
739
- @typing.final
740
- class FuzzyMatch(google.protobuf.message.Message):
741
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
742
-
743
- KIND_FIELD_NUMBER: builtins.int
744
- DISTANCE_FIELD_NUMBER: builtins.int
745
- kind: global___GraphQuery.Node.MatchLocation.ValueType
746
- distance: builtins.int
747
- def __init__(
748
- self,
749
- *,
750
- kind: global___GraphQuery.Node.MatchLocation.ValueType = ...,
751
- distance: builtins.int = ...,
752
- ) -> None: ...
753
- def ClearField(self, field_name: typing.Literal["distance", b"distance", "kind", b"kind"]) -> None: ...
754
-
755
- VALUE_FIELD_NUMBER: builtins.int
756
- NODE_TYPE_FIELD_NUMBER: builtins.int
757
- NODE_SUBTYPE_FIELD_NUMBER: builtins.int
758
- MATCH_KIND_FIELD_NUMBER: builtins.int
759
- EXACT_FIELD_NUMBER: builtins.int
760
- FUZZY_FIELD_NUMBER: builtins.int
761
- value: builtins.str
762
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType
763
- node_subtype: builtins.str
764
- match_kind: global___GraphQuery.Node.MatchKind.ValueType
765
- @property
766
- def exact(self) -> global___GraphQuery.Node.ExactMatch: ...
767
- @property
768
- def fuzzy(self) -> global___GraphQuery.Node.FuzzyMatch: ...
769
- def __init__(
770
- self,
771
- *,
772
- value: builtins.str | None = ...,
773
- node_type: nucliadb_protos.utils_pb2.RelationNode.NodeType.ValueType | None = ...,
774
- node_subtype: builtins.str | None = ...,
775
- match_kind: global___GraphQuery.Node.MatchKind.ValueType = ...,
776
- exact: global___GraphQuery.Node.ExactMatch | None = ...,
777
- fuzzy: global___GraphQuery.Node.FuzzyMatch | None = ...,
778
- ) -> None: ...
779
- 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: ...
780
- 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: ...
781
- @typing.overload
782
- def WhichOneof(self, oneof_group: typing.Literal["_node_subtype", b"_node_subtype"]) -> typing.Literal["node_subtype"] | None: ...
783
- @typing.overload
784
- def WhichOneof(self, oneof_group: typing.Literal["_node_type", b"_node_type"]) -> typing.Literal["node_type"] | None: ...
785
- @typing.overload
786
- def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
787
- @typing.overload
788
- def WhichOneof(self, oneof_group: typing.Literal["new_match_kind", b"new_match_kind"]) -> typing.Literal["exact", "fuzzy"] | None: ...
789
-
790
- @typing.final
791
- class Relation(google.protobuf.message.Message):
792
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
793
-
794
- VALUE_FIELD_NUMBER: builtins.int
795
- RELATION_TYPE_FIELD_NUMBER: builtins.int
796
- value: builtins.str
797
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
798
- def __init__(
799
- self,
800
- *,
801
- value: builtins.str | None = ...,
802
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType | None = ...,
803
- ) -> None: ...
804
- 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: ...
805
- def ClearField(self, field_name: typing.Literal["_relation_type", b"_relation_type", "_value", b"_value", "relation_type", b"relation_type", "value", b"value"]) -> None: ...
806
- @typing.overload
807
- def WhichOneof(self, oneof_group: typing.Literal["_relation_type", b"_relation_type"]) -> typing.Literal["relation_type"] | None: ...
808
- @typing.overload
809
- def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
810
-
811
- @typing.final
812
- class Path(google.protobuf.message.Message):
813
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
814
-
815
- SOURCE_FIELD_NUMBER: builtins.int
816
- RELATION_FIELD_NUMBER: builtins.int
817
- DESTINATION_FIELD_NUMBER: builtins.int
818
- UNDIRECTED_FIELD_NUMBER: builtins.int
819
- undirected: builtins.bool
820
- @property
821
- def source(self) -> global___GraphQuery.Node: ...
822
- @property
823
- def relation(self) -> global___GraphQuery.Relation: ...
824
- @property
825
- def destination(self) -> global___GraphQuery.Node: ...
826
- def __init__(
827
- self,
828
- *,
829
- source: global___GraphQuery.Node | None = ...,
830
- relation: global___GraphQuery.Relation | None = ...,
831
- destination: global___GraphQuery.Node | None = ...,
832
- undirected: builtins.bool = ...,
833
- ) -> None: ...
834
- 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: ...
835
- 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: ...
836
- @typing.overload
837
- def WhichOneof(self, oneof_group: typing.Literal["_destination", b"_destination"]) -> typing.Literal["destination"] | None: ...
838
- @typing.overload
839
- def WhichOneof(self, oneof_group: typing.Literal["_relation", b"_relation"]) -> typing.Literal["relation"] | None: ...
840
- @typing.overload
841
- def WhichOneof(self, oneof_group: typing.Literal["_source", b"_source"]) -> typing.Literal["source"] | None: ...
842
-
843
- @typing.final
844
- class BoolQuery(google.protobuf.message.Message):
845
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
846
-
847
- OPERANDS_FIELD_NUMBER: builtins.int
848
- @property
849
- def operands(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphQuery.PathQuery]: ...
850
- def __init__(
851
- self,
852
- *,
853
- operands: collections.abc.Iterable[global___GraphQuery.PathQuery] | None = ...,
854
- ) -> None: ...
855
- def ClearField(self, field_name: typing.Literal["operands", b"operands"]) -> None: ...
856
-
857
- @typing.final
858
- class FacetFilter(google.protobuf.message.Message):
859
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
860
-
861
- FACET_FIELD_NUMBER: builtins.int
862
- facet: builtins.str
863
- def __init__(
864
- self,
865
- *,
866
- facet: builtins.str = ...,
867
- ) -> None: ...
868
- def ClearField(self, field_name: typing.Literal["facet", b"facet"]) -> None: ...
869
-
870
- @typing.final
871
- class PathQuery(google.protobuf.message.Message):
872
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
873
-
874
- PATH_FIELD_NUMBER: builtins.int
875
- BOOL_NOT_FIELD_NUMBER: builtins.int
876
- BOOL_AND_FIELD_NUMBER: builtins.int
877
- BOOL_OR_FIELD_NUMBER: builtins.int
878
- FACET_FIELD_NUMBER: builtins.int
879
- @property
880
- def path(self) -> global___GraphQuery.Path: ...
881
- @property
882
- def bool_not(self) -> global___GraphQuery.PathQuery: ...
883
- @property
884
- def bool_and(self) -> global___GraphQuery.BoolQuery: ...
885
- @property
886
- def bool_or(self) -> global___GraphQuery.BoolQuery: ...
887
- @property
888
- def facet(self) -> global___GraphQuery.FacetFilter: ...
889
- def __init__(
890
- self,
891
- *,
892
- path: global___GraphQuery.Path | None = ...,
893
- bool_not: global___GraphQuery.PathQuery | None = ...,
894
- bool_and: global___GraphQuery.BoolQuery | None = ...,
895
- bool_or: global___GraphQuery.BoolQuery | None = ...,
896
- facet: global___GraphQuery.FacetFilter | None = ...,
897
- ) -> None: ...
898
- 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: ...
899
- 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: ...
900
- def WhichOneof(self, oneof_group: typing.Literal["query", b"query"]) -> typing.Literal["path", "bool_not", "bool_and", "bool_or", "facet"] | None: ...
901
-
902
- PATH_FIELD_NUMBER: builtins.int
903
- @property
904
- def path(self) -> global___GraphQuery.PathQuery:
905
- """Search directed/undirected paths (triplets of node-relation-node). It
906
- can also be used to express node and relation queries
907
- """
908
-
909
- def __init__(
910
- self,
911
- *,
912
- path: global___GraphQuery.PathQuery | None = ...,
913
- ) -> None: ...
914
- def HasField(self, field_name: typing.Literal["path", b"path"]) -> builtins.bool: ...
915
- def ClearField(self, field_name: typing.Literal["path", b"path"]) -> None: ...
916
-
917
- global___GraphQuery = GraphQuery
918
-
919
- @typing.final
920
- class GraphSearchRequest(google.protobuf.message.Message):
921
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
922
-
923
- class _QueryKind:
924
- ValueType = typing.NewType("ValueType", builtins.int)
925
- V: typing_extensions.TypeAlias = ValueType
926
-
927
- class _QueryKindEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[GraphSearchRequest._QueryKind.ValueType], builtins.type):
928
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
929
- PATH: GraphSearchRequest._QueryKind.ValueType # 0
930
- NODES: GraphSearchRequest._QueryKind.ValueType # 1
931
- RELATIONS: GraphSearchRequest._QueryKind.ValueType # 2
932
-
933
- class QueryKind(_QueryKind, metaclass=_QueryKindEnumTypeWrapper):
934
- """Decides what do we want in return: paths (triplets), nodes or relations.
935
- Returning paths implies returning nodes and relations.
936
- """
937
-
938
- PATH: GraphSearchRequest.QueryKind.ValueType # 0
939
- NODES: GraphSearchRequest.QueryKind.ValueType # 1
940
- RELATIONS: GraphSearchRequest.QueryKind.ValueType # 2
941
-
942
- SHARD_FIELD_NUMBER: builtins.int
943
- QUERY_FIELD_NUMBER: builtins.int
944
- KIND_FIELD_NUMBER: builtins.int
945
- TOP_K_FIELD_NUMBER: builtins.int
946
- SECURITY_FIELD_NUMBER: builtins.int
947
- FIELD_FILTER_FIELD_NUMBER: builtins.int
948
- shard: builtins.str
949
- kind: global___GraphSearchRequest.QueryKind.ValueType
950
- top_k: builtins.int
951
- @property
952
- def query(self) -> global___GraphQuery: ...
953
- @property
954
- def security(self) -> nucliadb_protos.utils_pb2.Security: ...
955
- @property
956
- def field_filter(self) -> global___FilterExpression: ...
957
- def __init__(
958
- self,
959
- *,
960
- shard: builtins.str = ...,
961
- query: global___GraphQuery | None = ...,
962
- kind: global___GraphSearchRequest.QueryKind.ValueType = ...,
963
- top_k: builtins.int = ...,
964
- security: nucliadb_protos.utils_pb2.Security | None = ...,
965
- field_filter: global___FilterExpression | None = ...,
966
- ) -> None: ...
967
- 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: ...
968
- 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: ...
969
- @typing.overload
970
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
971
- @typing.overload
972
- def WhichOneof(self, oneof_group: typing.Literal["_security", b"_security"]) -> typing.Literal["security"] | None: ...
973
-
974
- global___GraphSearchRequest = GraphSearchRequest
975
-
976
- @typing.final
977
- class GraphSearchResponse(google.protobuf.message.Message):
978
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
979
-
980
- @typing.final
981
- class Relation(google.protobuf.message.Message):
982
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
983
-
984
- RELATION_TYPE_FIELD_NUMBER: builtins.int
985
- LABEL_FIELD_NUMBER: builtins.int
986
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
987
- label: builtins.str
988
- def __init__(
989
- self,
990
- *,
991
- relation_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType = ...,
992
- label: builtins.str = ...,
993
- ) -> None: ...
994
- def ClearField(self, field_name: typing.Literal["label", b"label", "relation_type", b"relation_type"]) -> None: ...
995
-
996
- @typing.final
997
- class Path(google.protobuf.message.Message):
998
- """To optimize proto size, paths are built using pointers to nodes and
999
- relations. This avoid repetition of nodes/relations and allow smaller
1000
- protos for big graphs.
1001
- """
1002
-
1003
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1004
-
1005
- SOURCE_FIELD_NUMBER: builtins.int
1006
- RELATION_FIELD_NUMBER: builtins.int
1007
- DESTINATION_FIELD_NUMBER: builtins.int
1008
- METADATA_FIELD_NUMBER: builtins.int
1009
- RESOURCE_FIELD_ID_FIELD_NUMBER: builtins.int
1010
- FACETS_FIELD_NUMBER: builtins.int
1011
- source: builtins.int
1012
- relation: builtins.int
1013
- destination: builtins.int
1014
- resource_field_id: builtins.str
1015
- @property
1016
- def metadata(self) -> nucliadb_protos.utils_pb2.RelationMetadata: ...
1017
- @property
1018
- def facets(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1019
- def __init__(
1020
- self,
1021
- *,
1022
- source: builtins.int = ...,
1023
- relation: builtins.int = ...,
1024
- destination: builtins.int = ...,
1025
- metadata: nucliadb_protos.utils_pb2.RelationMetadata | None = ...,
1026
- resource_field_id: builtins.str | None = ...,
1027
- facets: collections.abc.Iterable[builtins.str] | None = ...,
1028
- ) -> None: ...
1029
- 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: ...
1030
- 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: ...
1031
- @typing.overload
1032
- def WhichOneof(self, oneof_group: typing.Literal["_metadata", b"_metadata"]) -> typing.Literal["metadata"] | None: ...
1033
- @typing.overload
1034
- def WhichOneof(self, oneof_group: typing.Literal["_resource_field_id", b"_resource_field_id"]) -> typing.Literal["resource_field_id"] | None: ...
1035
-
1036
- NODES_FIELD_NUMBER: builtins.int
1037
- RELATIONS_FIELD_NUMBER: builtins.int
1038
- GRAPH_FIELD_NUMBER: builtins.int
1039
- @property
1040
- def nodes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[nucliadb_protos.utils_pb2.RelationNode]: ...
1041
- @property
1042
- def relations(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphSearchResponse.Relation]: ...
1043
- @property
1044
- def graph(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___GraphSearchResponse.Path]: ...
1045
- def __init__(
1046
- self,
1047
- *,
1048
- nodes: collections.abc.Iterable[nucliadb_protos.utils_pb2.RelationNode] | None = ...,
1049
- relations: collections.abc.Iterable[global___GraphSearchResponse.Relation] | None = ...,
1050
- graph: collections.abc.Iterable[global___GraphSearchResponse.Path] | None = ...,
1051
- ) -> None: ...
1052
- def ClearField(self, field_name: typing.Literal["graph", b"graph", "nodes", b"nodes", "relations", b"relations"]) -> None: ...
1053
-
1054
- global___GraphSearchResponse = GraphSearchResponse
1055
-
1056
- @typing.final
1057
- class RelationSearchRequest(google.protobuf.message.Message):
1058
- """Query relation index to obtain different information about the
1059
- knowledge graph. It can be queried using the following strategies:
1060
-
1061
- - prefix search over vertex (node) names
1062
- - graph search:
1063
- - given some entry vertices, get the filtered subgraph around them
1064
- """
1065
-
1066
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1067
-
1068
- SHARD_ID_FIELD_NUMBER: builtins.int
1069
- SUBGRAPH_FIELD_NUMBER: builtins.int
1070
- shard_id: builtins.str
1071
- @property
1072
- def subgraph(self) -> global___EntitiesSubgraphRequest: ...
1073
- def __init__(
1074
- self,
1075
- *,
1076
- shard_id: builtins.str = ...,
1077
- subgraph: global___EntitiesSubgraphRequest | None = ...,
1078
- ) -> None: ...
1079
- def HasField(self, field_name: typing.Literal["subgraph", b"subgraph"]) -> builtins.bool: ...
1080
- def ClearField(self, field_name: typing.Literal["shard_id", b"shard_id", "subgraph", b"subgraph"]) -> None: ...
1081
-
1082
- global___RelationSearchRequest = RelationSearchRequest
1083
-
1084
- @typing.final
1085
- class RelationSearchResponse(google.protobuf.message.Message):
1086
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1087
-
1088
- PREFIX_FIELD_NUMBER: builtins.int
1089
- SUBGRAPH_FIELD_NUMBER: builtins.int
1090
- @property
1091
- def prefix(self) -> global___RelationPrefixSearchResponse: ...
1092
- @property
1093
- def subgraph(self) -> global___EntitiesSubgraphResponse: ...
1094
- def __init__(
1095
- self,
1096
- *,
1097
- prefix: global___RelationPrefixSearchResponse | None = ...,
1098
- subgraph: global___EntitiesSubgraphResponse | None = ...,
1099
- ) -> None: ...
1100
- def HasField(self, field_name: typing.Literal["prefix", b"prefix", "subgraph", b"subgraph"]) -> builtins.bool: ...
1101
- def ClearField(self, field_name: typing.Literal["prefix", b"prefix", "subgraph", b"subgraph"]) -> None: ...
1102
-
1103
- global___RelationSearchResponse = RelationSearchResponse
1104
-
1105
- @typing.final
1106
- class FilterExpression(google.protobuf.message.Message):
1107
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1108
-
1109
- @typing.final
1110
- class FilterExpressionList(google.protobuf.message.Message):
1111
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1112
-
1113
- OPERANDS_FIELD_NUMBER: builtins.int
1114
- @property
1115
- def operands(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FilterExpression]: ...
1116
- def __init__(
1117
- self,
1118
- *,
1119
- operands: collections.abc.Iterable[global___FilterExpression] | None = ...,
1120
- ) -> None: ...
1121
- def ClearField(self, field_name: typing.Literal["operands", b"operands"]) -> None: ...
1122
-
1123
- @typing.final
1124
- class ResourceFilter(google.protobuf.message.Message):
1125
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1126
-
1127
- RESOURCE_ID_FIELD_NUMBER: builtins.int
1128
- resource_id: builtins.str
1129
- def __init__(
1130
- self,
1131
- *,
1132
- resource_id: builtins.str = ...,
1133
- ) -> None: ...
1134
- def ClearField(self, field_name: typing.Literal["resource_id", b"resource_id"]) -> None: ...
1135
-
1136
- @typing.final
1137
- class FieldFilter(google.protobuf.message.Message):
1138
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1139
-
1140
- FIELD_TYPE_FIELD_NUMBER: builtins.int
1141
- FIELD_ID_FIELD_NUMBER: builtins.int
1142
- field_type: builtins.str
1143
- field_id: builtins.str
1144
- def __init__(
1145
- self,
1146
- *,
1147
- field_type: builtins.str = ...,
1148
- field_id: builtins.str | None = ...,
1149
- ) -> None: ...
1150
- def HasField(self, field_name: typing.Literal["_field_id", b"_field_id", "field_id", b"field_id"]) -> builtins.bool: ...
1151
- def ClearField(self, field_name: typing.Literal["_field_id", b"_field_id", "field_id", b"field_id", "field_type", b"field_type"]) -> None: ...
1152
- def WhichOneof(self, oneof_group: typing.Literal["_field_id", b"_field_id"]) -> typing.Literal["field_id"] | None: ...
1153
-
1154
- @typing.final
1155
- class DateRangeFilter(google.protobuf.message.Message):
1156
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1157
-
1158
- class _DateField:
1159
- ValueType = typing.NewType("ValueType", builtins.int)
1160
- V: typing_extensions.TypeAlias = ValueType
1161
-
1162
- class _DateFieldEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[FilterExpression.DateRangeFilter._DateField.ValueType], builtins.type):
1163
- DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
1164
- CREATED: FilterExpression.DateRangeFilter._DateField.ValueType # 0
1165
- MODIFIED: FilterExpression.DateRangeFilter._DateField.ValueType # 1
1166
-
1167
- class DateField(_DateField, metaclass=_DateFieldEnumTypeWrapper): ...
1168
- CREATED: FilterExpression.DateRangeFilter.DateField.ValueType # 0
1169
- MODIFIED: FilterExpression.DateRangeFilter.DateField.ValueType # 1
1170
-
1171
- FIELD_FIELD_NUMBER: builtins.int
1172
- SINCE_FIELD_NUMBER: builtins.int
1173
- UNTIL_FIELD_NUMBER: builtins.int
1174
- field: global___FilterExpression.DateRangeFilter.DateField.ValueType
1175
- @property
1176
- def since(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
1177
- @property
1178
- def until(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
1179
- def __init__(
1180
- self,
1181
- *,
1182
- field: global___FilterExpression.DateRangeFilter.DateField.ValueType = ...,
1183
- since: google.protobuf.timestamp_pb2.Timestamp | None = ...,
1184
- until: google.protobuf.timestamp_pb2.Timestamp | None = ...,
1185
- ) -> None: ...
1186
- def HasField(self, field_name: typing.Literal["_since", b"_since", "_until", b"_until", "since", b"since", "until", b"until"]) -> builtins.bool: ...
1187
- def ClearField(self, field_name: typing.Literal["_since", b"_since", "_until", b"_until", "field", b"field", "since", b"since", "until", b"until"]) -> None: ...
1188
- @typing.overload
1189
- def WhichOneof(self, oneof_group: typing.Literal["_since", b"_since"]) -> typing.Literal["since"] | None: ...
1190
- @typing.overload
1191
- def WhichOneof(self, oneof_group: typing.Literal["_until", b"_until"]) -> typing.Literal["until"] | None: ...
1192
-
1193
- @typing.final
1194
- class KeywordFilter(google.protobuf.message.Message):
1195
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1196
-
1197
- KEYWORD_FIELD_NUMBER: builtins.int
1198
- keyword: builtins.str
1199
- def __init__(
1200
- self,
1201
- *,
1202
- keyword: builtins.str = ...,
1203
- ) -> None: ...
1204
- def ClearField(self, field_name: typing.Literal["keyword", b"keyword"]) -> None: ...
1205
-
1206
- @typing.final
1207
- class FacetFilter(google.protobuf.message.Message):
1208
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1209
-
1210
- FACET_FIELD_NUMBER: builtins.int
1211
- facet: builtins.str
1212
- def __init__(
1213
- self,
1214
- *,
1215
- facet: builtins.str = ...,
1216
- ) -> None: ...
1217
- def ClearField(self, field_name: typing.Literal["facet", b"facet"]) -> None: ...
1218
-
1219
- BOOL_AND_FIELD_NUMBER: builtins.int
1220
- BOOL_OR_FIELD_NUMBER: builtins.int
1221
- BOOL_NOT_FIELD_NUMBER: builtins.int
1222
- RESOURCE_FIELD_NUMBER: builtins.int
1223
- FIELD_FIELD_NUMBER: builtins.int
1224
- KEYWORD_FIELD_NUMBER: builtins.int
1225
- DATE_FIELD_NUMBER: builtins.int
1226
- FACET_FIELD_NUMBER: builtins.int
1227
- @property
1228
- def bool_and(self) -> global___FilterExpression.FilterExpressionList: ...
1229
- @property
1230
- def bool_or(self) -> global___FilterExpression.FilterExpressionList: ...
1231
- @property
1232
- def bool_not(self) -> global___FilterExpression: ...
1233
- @property
1234
- def resource(self) -> global___FilterExpression.ResourceFilter: ...
1235
- @property
1236
- def field(self) -> global___FilterExpression.FieldFilter: ...
1237
- @property
1238
- def keyword(self) -> global___FilterExpression.KeywordFilter: ...
1239
- @property
1240
- def date(self) -> global___FilterExpression.DateRangeFilter: ...
1241
- @property
1242
- def facet(self) -> global___FilterExpression.FacetFilter: ...
1243
- def __init__(
1244
- self,
1245
- *,
1246
- bool_and: global___FilterExpression.FilterExpressionList | None = ...,
1247
- bool_or: global___FilterExpression.FilterExpressionList | None = ...,
1248
- bool_not: global___FilterExpression | None = ...,
1249
- resource: global___FilterExpression.ResourceFilter | None = ...,
1250
- field: global___FilterExpression.FieldFilter | None = ...,
1251
- keyword: global___FilterExpression.KeywordFilter | None = ...,
1252
- date: global___FilterExpression.DateRangeFilter | None = ...,
1253
- facet: global___FilterExpression.FacetFilter | None = ...,
1254
- ) -> None: ...
1255
- 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: ...
1256
- 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: ...
1257
- def WhichOneof(self, oneof_group: typing.Literal["expr", b"expr"]) -> typing.Literal["bool_and", "bool_or", "bool_not", "resource", "field", "keyword", "date", "facet"] | None: ...
1258
-
1259
- global___FilterExpression = FilterExpression
1260
-
1261
- @typing.final
1262
- class SearchRequest(google.protobuf.message.Message):
1263
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1264
-
1265
- @typing.final
1266
- class GraphSearch(google.protobuf.message.Message):
1267
- """Reduced graph search for specific use case of text block search. It only
1268
- supports path search (as it's the only one that can return paragraph_ids)
1269
- and filters are inherited from the main request
1270
- """
1271
-
1272
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1273
-
1274
- QUERY_FIELD_NUMBER: builtins.int
1275
- @property
1276
- def query(self) -> global___GraphQuery: ...
1277
- def __init__(
1278
- self,
1279
- *,
1280
- query: global___GraphQuery | None = ...,
1281
- ) -> None: ...
1282
- def HasField(self, field_name: typing.Literal["query", b"query"]) -> builtins.bool: ...
1283
- def ClearField(self, field_name: typing.Literal["query", b"query"]) -> None: ...
1284
-
1285
- SHARD_FIELD_NUMBER: builtins.int
1286
- BODY_FIELD_NUMBER: builtins.int
1287
- ORDER_FIELD_NUMBER: builtins.int
1288
- FACETED_FIELD_NUMBER: builtins.int
1289
- PAGE_NUMBER_FIELD_NUMBER: builtins.int
1290
- RESULT_PER_PAGE_FIELD_NUMBER: builtins.int
1291
- VECTOR_FIELD_NUMBER: builtins.int
1292
- VECTORSET_FIELD_NUMBER: builtins.int
1293
- PARAGRAPH_FIELD_NUMBER: builtins.int
1294
- DOCUMENT_FIELD_NUMBER: builtins.int
1295
- WITH_DUPLICATES_FIELD_NUMBER: builtins.int
1296
- ONLY_FACETED_FIELD_NUMBER: builtins.int
1297
- ADVANCED_QUERY_FIELD_NUMBER: builtins.int
1298
- MIN_SCORE_SEMANTIC_FIELD_NUMBER: builtins.int
1299
- MIN_SCORE_BM25_FIELD_NUMBER: builtins.int
1300
- SECURITY_FIELD_NUMBER: builtins.int
1301
- FIELD_FILTER_FIELD_NUMBER: builtins.int
1302
- PARAGRAPH_FILTER_FIELD_NUMBER: builtins.int
1303
- FILTER_OPERATOR_FIELD_NUMBER: builtins.int
1304
- RELATION_SUBGRAPH_FIELD_NUMBER: builtins.int
1305
- GRAPH_SEARCH_FIELD_NUMBER: builtins.int
1306
- shard: builtins.str
1307
- body: builtins.str
1308
- """query this text in all the paragraphs"""
1309
- page_number: builtins.int
1310
- result_per_page: builtins.int
1311
- vectorset: builtins.str
1312
- paragraph: builtins.bool
1313
- document: builtins.bool
1314
- with_duplicates: builtins.bool
1315
- only_faceted: builtins.bool
1316
- advanced_query: builtins.str
1317
- min_score_semantic: builtins.float
1318
- min_score_bm25: builtins.float
1319
- filter_operator: global___FilterOperator.ValueType
1320
- @property
1321
- def order(self) -> global___OrderBy: ...
1322
- @property
1323
- def faceted(self) -> global___Faceted: ...
1324
- @property
1325
- def vector(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]:
1326
- """Embedded vector search."""
1327
-
1328
- @property
1329
- def security(self) -> nucliadb_protos.utils_pb2.Security: ...
1330
- @property
1331
- def field_filter(self) -> global___FilterExpression: ...
1332
- @property
1333
- def paragraph_filter(self) -> global___FilterExpression: ...
1334
- @property
1335
- def relation_subgraph(self) -> global___EntitiesSubgraphRequest: ...
1336
- @property
1337
- def graph_search(self) -> global___SearchRequest.GraphSearch: ...
1338
- def __init__(
1339
- self,
1340
- *,
1341
- shard: builtins.str = ...,
1342
- body: builtins.str = ...,
1343
- order: global___OrderBy | None = ...,
1344
- faceted: global___Faceted | None = ...,
1345
- page_number: builtins.int = ...,
1346
- result_per_page: builtins.int = ...,
1347
- vector: collections.abc.Iterable[builtins.float] | None = ...,
1348
- vectorset: builtins.str = ...,
1349
- paragraph: builtins.bool = ...,
1350
- document: builtins.bool = ...,
1351
- with_duplicates: builtins.bool = ...,
1352
- only_faceted: builtins.bool = ...,
1353
- advanced_query: builtins.str | None = ...,
1354
- min_score_semantic: builtins.float = ...,
1355
- min_score_bm25: builtins.float = ...,
1356
- security: nucliadb_protos.utils_pb2.Security | None = ...,
1357
- field_filter: global___FilterExpression | None = ...,
1358
- paragraph_filter: global___FilterExpression | None = ...,
1359
- filter_operator: global___FilterOperator.ValueType = ...,
1360
- relation_subgraph: global___EntitiesSubgraphRequest | None = ...,
1361
- graph_search: global___SearchRequest.GraphSearch | None = ...,
1362
- ) -> None: ...
1363
- 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", "relation_subgraph", b"relation_subgraph", "security", b"security"]) -> builtins.bool: ...
1364
- 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", "relation_subgraph", b"relation_subgraph", "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: ...
1365
- @typing.overload
1366
- def WhichOneof(self, oneof_group: typing.Literal["_advanced_query", b"_advanced_query"]) -> typing.Literal["advanced_query"] | None: ...
1367
- @typing.overload
1368
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
1369
- @typing.overload
1370
- def WhichOneof(self, oneof_group: typing.Literal["_paragraph_filter", b"_paragraph_filter"]) -> typing.Literal["paragraph_filter"] | None: ...
1371
- @typing.overload
1372
- def WhichOneof(self, oneof_group: typing.Literal["_security", b"_security"]) -> typing.Literal["security"] | None: ...
1373
-
1374
- global___SearchRequest = SearchRequest
1375
-
1376
- @typing.final
1377
- class SuggestRequest(google.protobuf.message.Message):
1378
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1379
-
1380
- SHARD_FIELD_NUMBER: builtins.int
1381
- BODY_FIELD_NUMBER: builtins.int
1382
- FEATURES_FIELD_NUMBER: builtins.int
1383
- FIELD_FILTER_FIELD_NUMBER: builtins.int
1384
- PARAGRAPH_FILTER_FIELD_NUMBER: builtins.int
1385
- FILTER_OPERATOR_FIELD_NUMBER: builtins.int
1386
- shard: builtins.str
1387
- body: builtins.str
1388
- filter_operator: global___FilterOperator.ValueType
1389
- @property
1390
- def features(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___SuggestFeatures.ValueType]: ...
1391
- @property
1392
- def field_filter(self) -> global___FilterExpression: ...
1393
- @property
1394
- def paragraph_filter(self) -> global___FilterExpression: ...
1395
- def __init__(
1396
- self,
1397
- *,
1398
- shard: builtins.str = ...,
1399
- body: builtins.str = ...,
1400
- features: collections.abc.Iterable[global___SuggestFeatures.ValueType] | None = ...,
1401
- field_filter: global___FilterExpression | None = ...,
1402
- paragraph_filter: global___FilterExpression | None = ...,
1403
- filter_operator: global___FilterOperator.ValueType = ...,
1404
- ) -> None: ...
1405
- 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: ...
1406
- 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: ...
1407
- @typing.overload
1408
- def WhichOneof(self, oneof_group: typing.Literal["_field_filter", b"_field_filter"]) -> typing.Literal["field_filter"] | None: ...
1409
- @typing.overload
1410
- def WhichOneof(self, oneof_group: typing.Literal["_paragraph_filter", b"_paragraph_filter"]) -> typing.Literal["paragraph_filter"] | None: ...
1411
-
1412
- global___SuggestRequest = SuggestRequest
1413
-
1414
- @typing.final
1415
- class RelatedEntities(google.protobuf.message.Message):
1416
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1417
-
1418
- ENTITIES_FIELD_NUMBER: builtins.int
1419
- TOTAL_FIELD_NUMBER: builtins.int
1420
- total: builtins.int
1421
- @property
1422
- def entities(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1423
- def __init__(
1424
- self,
1425
- *,
1426
- entities: collections.abc.Iterable[builtins.str] | None = ...,
1427
- total: builtins.int = ...,
1428
- ) -> None: ...
1429
- def ClearField(self, field_name: typing.Literal["entities", b"entities", "total", b"total"]) -> None: ...
1430
-
1431
- global___RelatedEntities = RelatedEntities
1432
-
1433
- @typing.final
1434
- class SuggestResponse(google.protobuf.message.Message):
1435
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1436
-
1437
- TOTAL_FIELD_NUMBER: builtins.int
1438
- RESULTS_FIELD_NUMBER: builtins.int
1439
- QUERY_FIELD_NUMBER: builtins.int
1440
- EMATCHES_FIELD_NUMBER: builtins.int
1441
- ENTITY_RESULTS_FIELD_NUMBER: builtins.int
1442
- total: builtins.int
1443
- query: builtins.str
1444
- """The text that lead to this results"""
1445
- @property
1446
- def results(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ParagraphResult]: ...
1447
- @property
1448
- def ematches(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1449
- @property
1450
- def entity_results(self) -> global___RelationPrefixSearchResponse:
1451
- """Entities related with the query"""
1452
-
1453
- def __init__(
1454
- self,
1455
- *,
1456
- total: builtins.int = ...,
1457
- results: collections.abc.Iterable[global___ParagraphResult] | None = ...,
1458
- query: builtins.str = ...,
1459
- ematches: collections.abc.Iterable[builtins.str] | None = ...,
1460
- entity_results: global___RelationPrefixSearchResponse | None = ...,
1461
- ) -> None: ...
1462
- def HasField(self, field_name: typing.Literal["entity_results", b"entity_results"]) -> builtins.bool: ...
1463
- 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: ...
1464
-
1465
- global___SuggestResponse = SuggestResponse
1466
-
1467
- @typing.final
1468
- class SearchResponse(google.protobuf.message.Message):
1469
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1470
-
1471
- DOCUMENT_FIELD_NUMBER: builtins.int
1472
- PARAGRAPH_FIELD_NUMBER: builtins.int
1473
- VECTOR_FIELD_NUMBER: builtins.int
1474
- RELATION_FIELD_NUMBER: builtins.int
1475
- GRAPH_FIELD_NUMBER: builtins.int
1476
- @property
1477
- def document(self) -> global___DocumentSearchResponse: ...
1478
- @property
1479
- def paragraph(self) -> global___ParagraphSearchResponse: ...
1480
- @property
1481
- def vector(self) -> global___VectorSearchResponse: ...
1482
- @property
1483
- def relation(self) -> global___RelationSearchResponse: ...
1484
- @property
1485
- def graph(self) -> global___GraphSearchResponse: ...
1486
- def __init__(
1487
- self,
1488
- *,
1489
- document: global___DocumentSearchResponse | None = ...,
1490
- paragraph: global___ParagraphSearchResponse | None = ...,
1491
- vector: global___VectorSearchResponse | None = ...,
1492
- relation: global___RelationSearchResponse | None = ...,
1493
- graph: global___GraphSearchResponse | None = ...,
1494
- ) -> None: ...
1495
- def HasField(self, field_name: typing.Literal["document", b"document", "graph", b"graph", "paragraph", b"paragraph", "relation", b"relation", "vector", b"vector"]) -> builtins.bool: ...
1496
- def ClearField(self, field_name: typing.Literal["document", b"document", "graph", b"graph", "paragraph", b"paragraph", "relation", b"relation", "vector", b"vector"]) -> None: ...
1497
-
1498
- global___SearchResponse = SearchResponse
1499
-
1500
- @typing.final
1501
- class IdCollection(google.protobuf.message.Message):
1502
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1503
-
1504
- IDS_FIELD_NUMBER: builtins.int
1505
- @property
1506
- def ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1507
- def __init__(
1508
- self,
1509
- *,
1510
- ids: collections.abc.Iterable[builtins.str] | None = ...,
1511
- ) -> None: ...
1512
- def ClearField(self, field_name: typing.Literal["ids", b"ids"]) -> None: ...
1513
-
1514
- global___IdCollection = IdCollection
1515
-
1516
- @typing.final
1517
- class RelationEdge(google.protobuf.message.Message):
1518
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1519
-
1520
- EDGE_TYPE_FIELD_NUMBER: builtins.int
1521
- PROPERTY_FIELD_NUMBER: builtins.int
1522
- edge_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType
1523
- property: builtins.str
1524
- def __init__(
1525
- self,
1526
- *,
1527
- edge_type: nucliadb_protos.utils_pb2.Relation.RelationType.ValueType = ...,
1528
- property: builtins.str = ...,
1529
- ) -> None: ...
1530
- def ClearField(self, field_name: typing.Literal["edge_type", b"edge_type", "property", b"property"]) -> None: ...
1531
-
1532
- global___RelationEdge = RelationEdge
1533
-
1534
- @typing.final
1535
- class EdgeList(google.protobuf.message.Message):
1536
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1537
-
1538
- LIST_FIELD_NUMBER: builtins.int
1539
- @property
1540
- def list(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RelationEdge]: ...
1541
- def __init__(
1542
- self,
1543
- *,
1544
- list: collections.abc.Iterable[global___RelationEdge] | None = ...,
1545
- ) -> None: ...
1546
- def ClearField(self, field_name: typing.Literal["list", b"list"]) -> None: ...
1547
-
1548
- global___EdgeList = EdgeList
1549
-
1550
- @typing.final
1551
- class GetShardRequest(google.protobuf.message.Message):
1552
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1553
-
1554
- SHARD_ID_FIELD_NUMBER: builtins.int
1555
- VECTORSET_FIELD_NUMBER: builtins.int
1556
- vectorset: builtins.str
1557
- @property
1558
- def shard_id(self) -> nucliadb_protos.noderesources_pb2.ShardId: ...
1559
- def __init__(
1560
- self,
1561
- *,
1562
- shard_id: nucliadb_protos.noderesources_pb2.ShardId | None = ...,
1563
- vectorset: builtins.str = ...,
1564
- ) -> None: ...
1565
- def HasField(self, field_name: typing.Literal["shard_id", b"shard_id"]) -> builtins.bool: ...
1566
- def ClearField(self, field_name: typing.Literal["shard_id", b"shard_id", "vectorset", b"vectorset"]) -> None: ...
1567
-
1568
- global___GetShardRequest = GetShardRequest
1569
-
1570
- @typing.final
1571
- class ParagraphItem(google.protobuf.message.Message):
1572
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1573
-
1574
- ID_FIELD_NUMBER: builtins.int
1575
- LABELS_FIELD_NUMBER: builtins.int
1576
- id: builtins.str
1577
- @property
1578
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1579
- def __init__(
1580
- self,
1581
- *,
1582
- id: builtins.str = ...,
1583
- labels: collections.abc.Iterable[builtins.str] | None = ...,
1584
- ) -> None: ...
1585
- def ClearField(self, field_name: typing.Literal["id", b"id", "labels", b"labels"]) -> None: ...
1586
-
1587
- global___ParagraphItem = ParagraphItem
1588
-
1589
- @typing.final
1590
- class DocumentItem(google.protobuf.message.Message):
1591
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1592
-
1593
- UUID_FIELD_NUMBER: builtins.int
1594
- FIELD_FIELD_NUMBER: builtins.int
1595
- LABELS_FIELD_NUMBER: builtins.int
1596
- uuid: builtins.str
1597
- field: builtins.str
1598
- @property
1599
- def labels(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
1600
- def __init__(
1601
- self,
1602
- *,
1603
- uuid: builtins.str = ...,
1604
- field: builtins.str = ...,
1605
- labels: collections.abc.Iterable[builtins.str] | None = ...,
1606
- ) -> None: ...
1607
- def ClearField(self, field_name: typing.Literal["field", b"field", "labels", b"labels", "uuid", b"uuid"]) -> None: ...
1608
-
1609
- global___DocumentItem = DocumentItem
1610
-
1611
- @typing.final
1612
- class StreamRequest(google.protobuf.message.Message):
1613
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1614
-
1615
- SHARD_ID_FIELD_NUMBER: builtins.int
1616
- FILTER_FIELD_NUMBER: builtins.int
1617
- @property
1618
- def shard_id(self) -> nucliadb_protos.noderesources_pb2.ShardId: ...
1619
- @property
1620
- def filter(self) -> global___StreamFilter: ...
1621
- def __init__(
1622
- self,
1623
- *,
1624
- shard_id: nucliadb_protos.noderesources_pb2.ShardId | None = ...,
1625
- filter: global___StreamFilter | None = ...,
1626
- ) -> None: ...
1627
- def HasField(self, field_name: typing.Literal["filter", b"filter", "shard_id", b"shard_id"]) -> builtins.bool: ...
1628
- def ClearField(self, field_name: typing.Literal["filter", b"filter", "shard_id", b"shard_id"]) -> None: ...
1629
-
1630
- global___StreamRequest = StreamRequest
1631
-
1632
- @typing.final
1633
- class GetShardFilesRequest(google.protobuf.message.Message):
1634
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1635
-
1636
- SHARD_ID_FIELD_NUMBER: builtins.int
1637
- shard_id: builtins.str
1638
- def __init__(
1639
- self,
1640
- *,
1641
- shard_id: builtins.str = ...,
1642
- ) -> None: ...
1643
- def ClearField(self, field_name: typing.Literal["shard_id", b"shard_id"]) -> None: ...
1644
-
1645
- global___GetShardFilesRequest = GetShardFilesRequest
1646
-
1647
- @typing.final
1648
- class ShardFileList(google.protobuf.message.Message):
1649
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1650
-
1651
- FILES_FIELD_NUMBER: builtins.int
1652
- @property
1653
- def files(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ShardFile]: ...
1654
- def __init__(
1655
- self,
1656
- *,
1657
- files: collections.abc.Iterable[global___ShardFile] | None = ...,
1658
- ) -> None: ...
1659
- def ClearField(self, field_name: typing.Literal["files", b"files"]) -> None: ...
1660
-
1661
- global___ShardFileList = ShardFileList
1662
-
1663
- @typing.final
1664
- class ShardFile(google.protobuf.message.Message):
1665
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1666
-
1667
- RELATIVE_PATH_FIELD_NUMBER: builtins.int
1668
- SIZE_FIELD_NUMBER: builtins.int
1669
- relative_path: builtins.str
1670
- size: builtins.int
1671
- def __init__(
1672
- self,
1673
- *,
1674
- relative_path: builtins.str = ...,
1675
- size: builtins.int = ...,
1676
- ) -> None: ...
1677
- def ClearField(self, field_name: typing.Literal["relative_path", b"relative_path", "size", b"size"]) -> None: ...
1678
-
1679
- global___ShardFile = ShardFile
1680
-
1681
- @typing.final
1682
- class DownloadShardFileRequest(google.protobuf.message.Message):
1683
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1684
-
1685
- SHARD_ID_FIELD_NUMBER: builtins.int
1686
- RELATIVE_PATH_FIELD_NUMBER: builtins.int
1687
- shard_id: builtins.str
1688
- relative_path: builtins.str
1689
- def __init__(
1690
- self,
1691
- *,
1692
- shard_id: builtins.str = ...,
1693
- relative_path: builtins.str = ...,
1694
- ) -> None: ...
1695
- def ClearField(self, field_name: typing.Literal["relative_path", b"relative_path", "shard_id", b"shard_id"]) -> None: ...
1696
-
1697
- global___DownloadShardFileRequest = DownloadShardFileRequest
1698
-
1699
- @typing.final
1700
- class ShardFileChunk(google.protobuf.message.Message):
1701
- DESCRIPTOR: google.protobuf.descriptor.Descriptor
1702
-
1703
- DATA_FIELD_NUMBER: builtins.int
1704
- INDEX_FIELD_NUMBER: builtins.int
1705
- data: builtins.bytes
1706
- index: builtins.int
1707
- def __init__(
1708
- self,
1709
- *,
1710
- data: builtins.bytes = ...,
1711
- index: builtins.int = ...,
1712
- ) -> None: ...
1713
- def ClearField(self, field_name: typing.Literal["data", b"data", "index", b"index"]) -> None: ...
1714
-
1715
- global___ShardFileChunk = ShardFileChunk