hindsight-client 0.1.14__py3-none-any.whl → 0.1.16__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.
Files changed (114) hide show
  1. hindsight_client/hindsight_client.py +11 -10
  2. {hindsight_client-0.1.14.dist-info → hindsight_client-0.1.16.dist-info}/METADATA +1 -1
  3. hindsight_client-0.1.16.dist-info/RECORD +109 -0
  4. hindsight_client_api/__init__.py +21 -3
  5. hindsight_client_api/api/__init__.py +5 -1
  6. hindsight_client_api/api/banks_api.py +2045 -0
  7. hindsight_client_api/api/documents_api.py +1234 -0
  8. hindsight_client_api/api/entities_api.py +921 -0
  9. hindsight_client_api/api/memory_api.py +1901 -0
  10. hindsight_client_api/api/monitoring_api.py +1 -1
  11. hindsight_client_api/api/operations_api.py +610 -0
  12. hindsight_client_api/api_client.py +1 -1
  13. hindsight_client_api/configuration.py +2 -2
  14. hindsight_client_api/docs/BankListItem.md +2 -2
  15. hindsight_client_api/docs/BankStatsResponse.md +39 -0
  16. hindsight_client_api/docs/BanksApi.md +517 -0
  17. hindsight_client_api/docs/CancelOperationResponse.md +32 -0
  18. hindsight_client_api/docs/DeleteDocumentResponse.md +33 -0
  19. hindsight_client_api/docs/DeleteResponse.md +2 -0
  20. hindsight_client_api/docs/DocumentsApi.md +313 -0
  21. hindsight_client_api/docs/EntitiesApi.md +230 -0
  22. hindsight_client_api/docs/MemoryApi.md +499 -0
  23. hindsight_client_api/docs/OperationResponse.md +36 -0
  24. hindsight_client_api/docs/OperationsApi.md +154 -0
  25. hindsight_client_api/docs/OperationsListResponse.md +31 -0
  26. hindsight_client_api/exceptions.py +1 -1
  27. hindsight_client_api/models/__init__.py +6 -1
  28. hindsight_client_api/models/add_background_request.py +1 -1
  29. hindsight_client_api/models/background_response.py +1 -1
  30. hindsight_client_api/models/bank_list_item.py +13 -3
  31. hindsight_client_api/models/bank_list_response.py +1 -1
  32. hindsight_client_api/models/bank_profile_response.py +1 -1
  33. hindsight_client_api/models/bank_stats_response.py +105 -0
  34. hindsight_client_api/models/budget.py +1 -1
  35. hindsight_client_api/models/cancel_operation_response.py +91 -0
  36. hindsight_client_api/models/chunk_data.py +1 -1
  37. hindsight_client_api/models/chunk_include_options.py +1 -1
  38. hindsight_client_api/models/chunk_response.py +1 -1
  39. hindsight_client_api/models/create_bank_request.py +1 -1
  40. hindsight_client_api/models/delete_document_response.py +93 -0
  41. hindsight_client_api/models/delete_response.py +19 -5
  42. hindsight_client_api/models/disposition_traits.py +1 -1
  43. hindsight_client_api/models/document_response.py +1 -1
  44. hindsight_client_api/models/entity_detail_response.py +1 -1
  45. hindsight_client_api/models/entity_include_options.py +1 -1
  46. hindsight_client_api/models/entity_list_item.py +1 -1
  47. hindsight_client_api/models/entity_list_response.py +1 -1
  48. hindsight_client_api/models/entity_observation_response.py +1 -1
  49. hindsight_client_api/models/entity_state_response.py +1 -1
  50. hindsight_client_api/models/graph_data_response.py +1 -1
  51. hindsight_client_api/models/http_validation_error.py +1 -1
  52. hindsight_client_api/models/include_options.py +1 -1
  53. hindsight_client_api/models/list_documents_response.py +1 -1
  54. hindsight_client_api/models/list_memory_units_response.py +1 -1
  55. hindsight_client_api/models/memory_item.py +1 -1
  56. hindsight_client_api/models/operation_response.py +109 -0
  57. hindsight_client_api/models/operations_list_response.py +97 -0
  58. hindsight_client_api/models/recall_request.py +1 -1
  59. hindsight_client_api/models/recall_response.py +1 -1
  60. hindsight_client_api/models/recall_result.py +1 -1
  61. hindsight_client_api/models/reflect_fact.py +1 -1
  62. hindsight_client_api/models/reflect_include_options.py +1 -1
  63. hindsight_client_api/models/reflect_request.py +1 -1
  64. hindsight_client_api/models/reflect_response.py +1 -1
  65. hindsight_client_api/models/retain_request.py +1 -1
  66. hindsight_client_api/models/retain_response.py +1 -1
  67. hindsight_client_api/models/update_disposition_request.py +1 -1
  68. hindsight_client_api/models/validation_error.py +1 -1
  69. hindsight_client_api/models/validation_error_loc_inner.py +1 -1
  70. hindsight_client_api/rest.py +1 -1
  71. hindsight_client-0.1.14.dist-info/RECORD +0 -131
  72. hindsight_client_api/api/default_api.py +0 -5976
  73. hindsight_client_api/docs/DefaultApi.md +0 -1568
  74. hindsight_client_api/test/__init__.py +0 -0
  75. hindsight_client_api/test/test_add_background_request.py +0 -53
  76. hindsight_client_api/test/test_background_response.py +0 -53
  77. hindsight_client_api/test/test_bank_list_item.py +0 -60
  78. hindsight_client_api/test/test_bank_list_response.py +0 -68
  79. hindsight_client_api/test/test_bank_profile_response.py +0 -58
  80. hindsight_client_api/test/test_budget.py +0 -33
  81. hindsight_client_api/test/test_chunk_data.py +0 -57
  82. hindsight_client_api/test/test_chunk_include_options.py +0 -51
  83. hindsight_client_api/test/test_chunk_response.py +0 -62
  84. hindsight_client_api/test/test_create_bank_request.py +0 -53
  85. hindsight_client_api/test/test_default_api.py +0 -178
  86. hindsight_client_api/test/test_delete_response.py +0 -52
  87. hindsight_client_api/test/test_disposition_traits.py +0 -56
  88. hindsight_client_api/test/test_document_response.py +0 -64
  89. hindsight_client_api/test/test_entity_detail_response.py +0 -71
  90. hindsight_client_api/test/test_entity_include_options.py +0 -51
  91. hindsight_client_api/test/test_entity_list_item.py +0 -61
  92. hindsight_client_api/test/test_entity_list_response.py +0 -56
  93. hindsight_client_api/test/test_entity_observation_response.py +0 -53
  94. hindsight_client_api/test/test_entity_state_response.py +0 -64
  95. hindsight_client_api/test/test_graph_data_response.py +0 -82
  96. hindsight_client_api/test/test_http_validation_error.py +0 -58
  97. hindsight_client_api/test/test_include_options.py +0 -54
  98. hindsight_client_api/test/test_list_documents_response.py +0 -66
  99. hindsight_client_api/test/test_list_memory_units_response.py +0 -66
  100. hindsight_client_api/test/test_memory_item.py +0 -58
  101. hindsight_client_api/test/test_monitoring_api.py +0 -45
  102. hindsight_client_api/test/test_recall_request.py +0 -64
  103. hindsight_client_api/test/test_recall_response.py +0 -76
  104. hindsight_client_api/test/test_recall_result.py +0 -67
  105. hindsight_client_api/test/test_reflect_fact.py +0 -57
  106. hindsight_client_api/test/test_reflect_include_options.py +0 -51
  107. hindsight_client_api/test/test_reflect_request.py +0 -56
  108. hindsight_client_api/test/test_reflect_response.py +0 -55
  109. hindsight_client_api/test/test_retain_request.py +0 -57
  110. hindsight_client_api/test/test_retain_response.py +0 -58
  111. hindsight_client_api/test/test_update_disposition_request.py +0 -52
  112. hindsight_client_api/test/test_validation_error.py +0 -60
  113. hindsight_client_api/test/test_validation_error_loc_inner.py +0 -50
  114. {hindsight_client-0.1.14.dist-info → hindsight_client-0.1.16.dist-info}/WHEEL +0 -0
@@ -0,0 +1,921 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Hindsight HTTP API
5
+
6
+ HTTP API for Hindsight
7
+
8
+ The version of the OpenAPI document: 0.1.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictInt, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
23
+ from hindsight_client_api.models.entity_list_response import EntityListResponse
24
+
25
+ from hindsight_client_api.api_client import ApiClient, RequestSerialized
26
+ from hindsight_client_api.api_response import ApiResponse
27
+ from hindsight_client_api.rest import RESTResponseType
28
+
29
+
30
+ class EntitiesApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ async def get_entity(
45
+ self,
46
+ bank_id: StrictStr,
47
+ entity_id: StrictStr,
48
+ authorization: Optional[StrictStr] = None,
49
+ _request_timeout: Union[
50
+ None,
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Tuple[
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Annotated[StrictFloat, Field(gt=0)]
55
+ ]
56
+ ] = None,
57
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
58
+ _content_type: Optional[StrictStr] = None,
59
+ _headers: Optional[Dict[StrictStr, Any]] = None,
60
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
61
+ ) -> EntityDetailResponse:
62
+ """Get entity details
63
+
64
+ Get detailed information about an entity including observations (mental model).
65
+
66
+ :param bank_id: (required)
67
+ :type bank_id: str
68
+ :param entity_id: (required)
69
+ :type entity_id: str
70
+ :param authorization:
71
+ :type authorization: str
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._get_entity_serialize(
95
+ bank_id=bank_id,
96
+ entity_id=entity_id,
97
+ authorization=authorization,
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ '200': "EntityDetailResponse",
106
+ '422': "HTTPValidationError",
107
+ }
108
+ response_data = await self.api_client.call_api(
109
+ *_param,
110
+ _request_timeout=_request_timeout
111
+ )
112
+ await response_data.read()
113
+ return self.api_client.response_deserialize(
114
+ response_data=response_data,
115
+ response_types_map=_response_types_map,
116
+ ).data
117
+
118
+
119
+ @validate_call
120
+ async def get_entity_with_http_info(
121
+ self,
122
+ bank_id: StrictStr,
123
+ entity_id: StrictStr,
124
+ authorization: Optional[StrictStr] = None,
125
+ _request_timeout: Union[
126
+ None,
127
+ Annotated[StrictFloat, Field(gt=0)],
128
+ Tuple[
129
+ Annotated[StrictFloat, Field(gt=0)],
130
+ Annotated[StrictFloat, Field(gt=0)]
131
+ ]
132
+ ] = None,
133
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
134
+ _content_type: Optional[StrictStr] = None,
135
+ _headers: Optional[Dict[StrictStr, Any]] = None,
136
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
137
+ ) -> ApiResponse[EntityDetailResponse]:
138
+ """Get entity details
139
+
140
+ Get detailed information about an entity including observations (mental model).
141
+
142
+ :param bank_id: (required)
143
+ :type bank_id: str
144
+ :param entity_id: (required)
145
+ :type entity_id: str
146
+ :param authorization:
147
+ :type authorization: str
148
+ :param _request_timeout: timeout setting for this request. If one
149
+ number provided, it will be total request
150
+ timeout. It can also be a pair (tuple) of
151
+ (connection, read) timeouts.
152
+ :type _request_timeout: int, tuple(int, int), optional
153
+ :param _request_auth: set to override the auth_settings for an a single
154
+ request; this effectively ignores the
155
+ authentication in the spec for a single request.
156
+ :type _request_auth: dict, optional
157
+ :param _content_type: force content-type for the request.
158
+ :type _content_type: str, Optional
159
+ :param _headers: set to override the headers for a single
160
+ request; this effectively ignores the headers
161
+ in the spec for a single request.
162
+ :type _headers: dict, optional
163
+ :param _host_index: set to override the host_index for a single
164
+ request; this effectively ignores the host_index
165
+ in the spec for a single request.
166
+ :type _host_index: int, optional
167
+ :return: Returns the result object.
168
+ """ # noqa: E501
169
+
170
+ _param = self._get_entity_serialize(
171
+ bank_id=bank_id,
172
+ entity_id=entity_id,
173
+ authorization=authorization,
174
+ _request_auth=_request_auth,
175
+ _content_type=_content_type,
176
+ _headers=_headers,
177
+ _host_index=_host_index
178
+ )
179
+
180
+ _response_types_map: Dict[str, Optional[str]] = {
181
+ '200': "EntityDetailResponse",
182
+ '422': "HTTPValidationError",
183
+ }
184
+ response_data = await self.api_client.call_api(
185
+ *_param,
186
+ _request_timeout=_request_timeout
187
+ )
188
+ await response_data.read()
189
+ return self.api_client.response_deserialize(
190
+ response_data=response_data,
191
+ response_types_map=_response_types_map,
192
+ )
193
+
194
+
195
+ @validate_call
196
+ async def get_entity_without_preload_content(
197
+ self,
198
+ bank_id: StrictStr,
199
+ entity_id: StrictStr,
200
+ authorization: Optional[StrictStr] = None,
201
+ _request_timeout: Union[
202
+ None,
203
+ Annotated[StrictFloat, Field(gt=0)],
204
+ Tuple[
205
+ Annotated[StrictFloat, Field(gt=0)],
206
+ Annotated[StrictFloat, Field(gt=0)]
207
+ ]
208
+ ] = None,
209
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
210
+ _content_type: Optional[StrictStr] = None,
211
+ _headers: Optional[Dict[StrictStr, Any]] = None,
212
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
213
+ ) -> RESTResponseType:
214
+ """Get entity details
215
+
216
+ Get detailed information about an entity including observations (mental model).
217
+
218
+ :param bank_id: (required)
219
+ :type bank_id: str
220
+ :param entity_id: (required)
221
+ :type entity_id: str
222
+ :param authorization:
223
+ :type authorization: str
224
+ :param _request_timeout: timeout setting for this request. If one
225
+ number provided, it will be total request
226
+ timeout. It can also be a pair (tuple) of
227
+ (connection, read) timeouts.
228
+ :type _request_timeout: int, tuple(int, int), optional
229
+ :param _request_auth: set to override the auth_settings for an a single
230
+ request; this effectively ignores the
231
+ authentication in the spec for a single request.
232
+ :type _request_auth: dict, optional
233
+ :param _content_type: force content-type for the request.
234
+ :type _content_type: str, Optional
235
+ :param _headers: set to override the headers for a single
236
+ request; this effectively ignores the headers
237
+ in the spec for a single request.
238
+ :type _headers: dict, optional
239
+ :param _host_index: set to override the host_index for a single
240
+ request; this effectively ignores the host_index
241
+ in the spec for a single request.
242
+ :type _host_index: int, optional
243
+ :return: Returns the result object.
244
+ """ # noqa: E501
245
+
246
+ _param = self._get_entity_serialize(
247
+ bank_id=bank_id,
248
+ entity_id=entity_id,
249
+ authorization=authorization,
250
+ _request_auth=_request_auth,
251
+ _content_type=_content_type,
252
+ _headers=_headers,
253
+ _host_index=_host_index
254
+ )
255
+
256
+ _response_types_map: Dict[str, Optional[str]] = {
257
+ '200': "EntityDetailResponse",
258
+ '422': "HTTPValidationError",
259
+ }
260
+ response_data = await self.api_client.call_api(
261
+ *_param,
262
+ _request_timeout=_request_timeout
263
+ )
264
+ return response_data.response
265
+
266
+
267
+ def _get_entity_serialize(
268
+ self,
269
+ bank_id,
270
+ entity_id,
271
+ authorization,
272
+ _request_auth,
273
+ _content_type,
274
+ _headers,
275
+ _host_index,
276
+ ) -> RequestSerialized:
277
+
278
+ _host = None
279
+
280
+ _collection_formats: Dict[str, str] = {
281
+ }
282
+
283
+ _path_params: Dict[str, str] = {}
284
+ _query_params: List[Tuple[str, str]] = []
285
+ _header_params: Dict[str, Optional[str]] = _headers or {}
286
+ _form_params: List[Tuple[str, str]] = []
287
+ _files: Dict[
288
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
289
+ ] = {}
290
+ _body_params: Optional[bytes] = None
291
+
292
+ # process the path parameters
293
+ if bank_id is not None:
294
+ _path_params['bank_id'] = bank_id
295
+ if entity_id is not None:
296
+ _path_params['entity_id'] = entity_id
297
+ # process the query parameters
298
+ # process the header parameters
299
+ if authorization is not None:
300
+ _header_params['authorization'] = authorization
301
+ # process the form parameters
302
+ # process the body parameter
303
+
304
+
305
+ # set the HTTP header `Accept`
306
+ if 'Accept' not in _header_params:
307
+ _header_params['Accept'] = self.api_client.select_header_accept(
308
+ [
309
+ 'application/json'
310
+ ]
311
+ )
312
+
313
+
314
+ # authentication setting
315
+ _auth_settings: List[str] = [
316
+ ]
317
+
318
+ return self.api_client.param_serialize(
319
+ method='GET',
320
+ resource_path='/v1/default/banks/{bank_id}/entities/{entity_id}',
321
+ path_params=_path_params,
322
+ query_params=_query_params,
323
+ header_params=_header_params,
324
+ body=_body_params,
325
+ post_params=_form_params,
326
+ files=_files,
327
+ auth_settings=_auth_settings,
328
+ collection_formats=_collection_formats,
329
+ _host=_host,
330
+ _request_auth=_request_auth
331
+ )
332
+
333
+
334
+
335
+
336
+ @validate_call
337
+ async def list_entities(
338
+ self,
339
+ bank_id: StrictStr,
340
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of entities to return")] = None,
341
+ authorization: Optional[StrictStr] = None,
342
+ _request_timeout: Union[
343
+ None,
344
+ Annotated[StrictFloat, Field(gt=0)],
345
+ Tuple[
346
+ Annotated[StrictFloat, Field(gt=0)],
347
+ Annotated[StrictFloat, Field(gt=0)]
348
+ ]
349
+ ] = None,
350
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
351
+ _content_type: Optional[StrictStr] = None,
352
+ _headers: Optional[Dict[StrictStr, Any]] = None,
353
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
354
+ ) -> EntityListResponse:
355
+ """List entities
356
+
357
+ List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
358
+
359
+ :param bank_id: (required)
360
+ :type bank_id: str
361
+ :param limit: Maximum number of entities to return
362
+ :type limit: int
363
+ :param authorization:
364
+ :type authorization: str
365
+ :param _request_timeout: timeout setting for this request. If one
366
+ number provided, it will be total request
367
+ timeout. It can also be a pair (tuple) of
368
+ (connection, read) timeouts.
369
+ :type _request_timeout: int, tuple(int, int), optional
370
+ :param _request_auth: set to override the auth_settings for an a single
371
+ request; this effectively ignores the
372
+ authentication in the spec for a single request.
373
+ :type _request_auth: dict, optional
374
+ :param _content_type: force content-type for the request.
375
+ :type _content_type: str, Optional
376
+ :param _headers: set to override the headers for a single
377
+ request; this effectively ignores the headers
378
+ in the spec for a single request.
379
+ :type _headers: dict, optional
380
+ :param _host_index: set to override the host_index for a single
381
+ request; this effectively ignores the host_index
382
+ in the spec for a single request.
383
+ :type _host_index: int, optional
384
+ :return: Returns the result object.
385
+ """ # noqa: E501
386
+
387
+ _param = self._list_entities_serialize(
388
+ bank_id=bank_id,
389
+ limit=limit,
390
+ authorization=authorization,
391
+ _request_auth=_request_auth,
392
+ _content_type=_content_type,
393
+ _headers=_headers,
394
+ _host_index=_host_index
395
+ )
396
+
397
+ _response_types_map: Dict[str, Optional[str]] = {
398
+ '200': "EntityListResponse",
399
+ '422': "HTTPValidationError",
400
+ }
401
+ response_data = await self.api_client.call_api(
402
+ *_param,
403
+ _request_timeout=_request_timeout
404
+ )
405
+ await response_data.read()
406
+ return self.api_client.response_deserialize(
407
+ response_data=response_data,
408
+ response_types_map=_response_types_map,
409
+ ).data
410
+
411
+
412
+ @validate_call
413
+ async def list_entities_with_http_info(
414
+ self,
415
+ bank_id: StrictStr,
416
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of entities to return")] = None,
417
+ authorization: Optional[StrictStr] = None,
418
+ _request_timeout: Union[
419
+ None,
420
+ Annotated[StrictFloat, Field(gt=0)],
421
+ Tuple[
422
+ Annotated[StrictFloat, Field(gt=0)],
423
+ Annotated[StrictFloat, Field(gt=0)]
424
+ ]
425
+ ] = None,
426
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
427
+ _content_type: Optional[StrictStr] = None,
428
+ _headers: Optional[Dict[StrictStr, Any]] = None,
429
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
430
+ ) -> ApiResponse[EntityListResponse]:
431
+ """List entities
432
+
433
+ List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
434
+
435
+ :param bank_id: (required)
436
+ :type bank_id: str
437
+ :param limit: Maximum number of entities to return
438
+ :type limit: int
439
+ :param authorization:
440
+ :type authorization: str
441
+ :param _request_timeout: timeout setting for this request. If one
442
+ number provided, it will be total request
443
+ timeout. It can also be a pair (tuple) of
444
+ (connection, read) timeouts.
445
+ :type _request_timeout: int, tuple(int, int), optional
446
+ :param _request_auth: set to override the auth_settings for an a single
447
+ request; this effectively ignores the
448
+ authentication in the spec for a single request.
449
+ :type _request_auth: dict, optional
450
+ :param _content_type: force content-type for the request.
451
+ :type _content_type: str, Optional
452
+ :param _headers: set to override the headers for a single
453
+ request; this effectively ignores the headers
454
+ in the spec for a single request.
455
+ :type _headers: dict, optional
456
+ :param _host_index: set to override the host_index for a single
457
+ request; this effectively ignores the host_index
458
+ in the spec for a single request.
459
+ :type _host_index: int, optional
460
+ :return: Returns the result object.
461
+ """ # noqa: E501
462
+
463
+ _param = self._list_entities_serialize(
464
+ bank_id=bank_id,
465
+ limit=limit,
466
+ authorization=authorization,
467
+ _request_auth=_request_auth,
468
+ _content_type=_content_type,
469
+ _headers=_headers,
470
+ _host_index=_host_index
471
+ )
472
+
473
+ _response_types_map: Dict[str, Optional[str]] = {
474
+ '200': "EntityListResponse",
475
+ '422': "HTTPValidationError",
476
+ }
477
+ response_data = await self.api_client.call_api(
478
+ *_param,
479
+ _request_timeout=_request_timeout
480
+ )
481
+ await response_data.read()
482
+ return self.api_client.response_deserialize(
483
+ response_data=response_data,
484
+ response_types_map=_response_types_map,
485
+ )
486
+
487
+
488
+ @validate_call
489
+ async def list_entities_without_preload_content(
490
+ self,
491
+ bank_id: StrictStr,
492
+ limit: Annotated[Optional[StrictInt], Field(description="Maximum number of entities to return")] = None,
493
+ authorization: Optional[StrictStr] = None,
494
+ _request_timeout: Union[
495
+ None,
496
+ Annotated[StrictFloat, Field(gt=0)],
497
+ Tuple[
498
+ Annotated[StrictFloat, Field(gt=0)],
499
+ Annotated[StrictFloat, Field(gt=0)]
500
+ ]
501
+ ] = None,
502
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
503
+ _content_type: Optional[StrictStr] = None,
504
+ _headers: Optional[Dict[StrictStr, Any]] = None,
505
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
506
+ ) -> RESTResponseType:
507
+ """List entities
508
+
509
+ List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
510
+
511
+ :param bank_id: (required)
512
+ :type bank_id: str
513
+ :param limit: Maximum number of entities to return
514
+ :type limit: int
515
+ :param authorization:
516
+ :type authorization: str
517
+ :param _request_timeout: timeout setting for this request. If one
518
+ number provided, it will be total request
519
+ timeout. It can also be a pair (tuple) of
520
+ (connection, read) timeouts.
521
+ :type _request_timeout: int, tuple(int, int), optional
522
+ :param _request_auth: set to override the auth_settings for an a single
523
+ request; this effectively ignores the
524
+ authentication in the spec for a single request.
525
+ :type _request_auth: dict, optional
526
+ :param _content_type: force content-type for the request.
527
+ :type _content_type: str, Optional
528
+ :param _headers: set to override the headers for a single
529
+ request; this effectively ignores the headers
530
+ in the spec for a single request.
531
+ :type _headers: dict, optional
532
+ :param _host_index: set to override the host_index for a single
533
+ request; this effectively ignores the host_index
534
+ in the spec for a single request.
535
+ :type _host_index: int, optional
536
+ :return: Returns the result object.
537
+ """ # noqa: E501
538
+
539
+ _param = self._list_entities_serialize(
540
+ bank_id=bank_id,
541
+ limit=limit,
542
+ authorization=authorization,
543
+ _request_auth=_request_auth,
544
+ _content_type=_content_type,
545
+ _headers=_headers,
546
+ _host_index=_host_index
547
+ )
548
+
549
+ _response_types_map: Dict[str, Optional[str]] = {
550
+ '200': "EntityListResponse",
551
+ '422': "HTTPValidationError",
552
+ }
553
+ response_data = await self.api_client.call_api(
554
+ *_param,
555
+ _request_timeout=_request_timeout
556
+ )
557
+ return response_data.response
558
+
559
+
560
+ def _list_entities_serialize(
561
+ self,
562
+ bank_id,
563
+ limit,
564
+ authorization,
565
+ _request_auth,
566
+ _content_type,
567
+ _headers,
568
+ _host_index,
569
+ ) -> RequestSerialized:
570
+
571
+ _host = None
572
+
573
+ _collection_formats: Dict[str, str] = {
574
+ }
575
+
576
+ _path_params: Dict[str, str] = {}
577
+ _query_params: List[Tuple[str, str]] = []
578
+ _header_params: Dict[str, Optional[str]] = _headers or {}
579
+ _form_params: List[Tuple[str, str]] = []
580
+ _files: Dict[
581
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
582
+ ] = {}
583
+ _body_params: Optional[bytes] = None
584
+
585
+ # process the path parameters
586
+ if bank_id is not None:
587
+ _path_params['bank_id'] = bank_id
588
+ # process the query parameters
589
+ if limit is not None:
590
+
591
+ _query_params.append(('limit', limit))
592
+
593
+ # process the header parameters
594
+ if authorization is not None:
595
+ _header_params['authorization'] = authorization
596
+ # process the form parameters
597
+ # process the body parameter
598
+
599
+
600
+ # set the HTTP header `Accept`
601
+ if 'Accept' not in _header_params:
602
+ _header_params['Accept'] = self.api_client.select_header_accept(
603
+ [
604
+ 'application/json'
605
+ ]
606
+ )
607
+
608
+
609
+ # authentication setting
610
+ _auth_settings: List[str] = [
611
+ ]
612
+
613
+ return self.api_client.param_serialize(
614
+ method='GET',
615
+ resource_path='/v1/default/banks/{bank_id}/entities',
616
+ path_params=_path_params,
617
+ query_params=_query_params,
618
+ header_params=_header_params,
619
+ body=_body_params,
620
+ post_params=_form_params,
621
+ files=_files,
622
+ auth_settings=_auth_settings,
623
+ collection_formats=_collection_formats,
624
+ _host=_host,
625
+ _request_auth=_request_auth
626
+ )
627
+
628
+
629
+
630
+
631
+ @validate_call
632
+ async def regenerate_entity_observations(
633
+ self,
634
+ bank_id: StrictStr,
635
+ entity_id: StrictStr,
636
+ authorization: Optional[StrictStr] = None,
637
+ _request_timeout: Union[
638
+ None,
639
+ Annotated[StrictFloat, Field(gt=0)],
640
+ Tuple[
641
+ Annotated[StrictFloat, Field(gt=0)],
642
+ Annotated[StrictFloat, Field(gt=0)]
643
+ ]
644
+ ] = None,
645
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
646
+ _content_type: Optional[StrictStr] = None,
647
+ _headers: Optional[Dict[StrictStr, Any]] = None,
648
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
649
+ ) -> EntityDetailResponse:
650
+ """Regenerate entity observations
651
+
652
+ Regenerate observations for an entity based on all facts mentioning it.
653
+
654
+ :param bank_id: (required)
655
+ :type bank_id: str
656
+ :param entity_id: (required)
657
+ :type entity_id: str
658
+ :param authorization:
659
+ :type authorization: str
660
+ :param _request_timeout: timeout setting for this request. If one
661
+ number provided, it will be total request
662
+ timeout. It can also be a pair (tuple) of
663
+ (connection, read) timeouts.
664
+ :type _request_timeout: int, tuple(int, int), optional
665
+ :param _request_auth: set to override the auth_settings for an a single
666
+ request; this effectively ignores the
667
+ authentication in the spec for a single request.
668
+ :type _request_auth: dict, optional
669
+ :param _content_type: force content-type for the request.
670
+ :type _content_type: str, Optional
671
+ :param _headers: set to override the headers for a single
672
+ request; this effectively ignores the headers
673
+ in the spec for a single request.
674
+ :type _headers: dict, optional
675
+ :param _host_index: set to override the host_index for a single
676
+ request; this effectively ignores the host_index
677
+ in the spec for a single request.
678
+ :type _host_index: int, optional
679
+ :return: Returns the result object.
680
+ """ # noqa: E501
681
+
682
+ _param = self._regenerate_entity_observations_serialize(
683
+ bank_id=bank_id,
684
+ entity_id=entity_id,
685
+ authorization=authorization,
686
+ _request_auth=_request_auth,
687
+ _content_type=_content_type,
688
+ _headers=_headers,
689
+ _host_index=_host_index
690
+ )
691
+
692
+ _response_types_map: Dict[str, Optional[str]] = {
693
+ '200': "EntityDetailResponse",
694
+ '422': "HTTPValidationError",
695
+ }
696
+ response_data = await self.api_client.call_api(
697
+ *_param,
698
+ _request_timeout=_request_timeout
699
+ )
700
+ await response_data.read()
701
+ return self.api_client.response_deserialize(
702
+ response_data=response_data,
703
+ response_types_map=_response_types_map,
704
+ ).data
705
+
706
+
707
+ @validate_call
708
+ async def regenerate_entity_observations_with_http_info(
709
+ self,
710
+ bank_id: StrictStr,
711
+ entity_id: StrictStr,
712
+ authorization: Optional[StrictStr] = None,
713
+ _request_timeout: Union[
714
+ None,
715
+ Annotated[StrictFloat, Field(gt=0)],
716
+ Tuple[
717
+ Annotated[StrictFloat, Field(gt=0)],
718
+ Annotated[StrictFloat, Field(gt=0)]
719
+ ]
720
+ ] = None,
721
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
722
+ _content_type: Optional[StrictStr] = None,
723
+ _headers: Optional[Dict[StrictStr, Any]] = None,
724
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
725
+ ) -> ApiResponse[EntityDetailResponse]:
726
+ """Regenerate entity observations
727
+
728
+ Regenerate observations for an entity based on all facts mentioning it.
729
+
730
+ :param bank_id: (required)
731
+ :type bank_id: str
732
+ :param entity_id: (required)
733
+ :type entity_id: str
734
+ :param authorization:
735
+ :type authorization: str
736
+ :param _request_timeout: timeout setting for this request. If one
737
+ number provided, it will be total request
738
+ timeout. It can also be a pair (tuple) of
739
+ (connection, read) timeouts.
740
+ :type _request_timeout: int, tuple(int, int), optional
741
+ :param _request_auth: set to override the auth_settings for an a single
742
+ request; this effectively ignores the
743
+ authentication in the spec for a single request.
744
+ :type _request_auth: dict, optional
745
+ :param _content_type: force content-type for the request.
746
+ :type _content_type: str, Optional
747
+ :param _headers: set to override the headers for a single
748
+ request; this effectively ignores the headers
749
+ in the spec for a single request.
750
+ :type _headers: dict, optional
751
+ :param _host_index: set to override the host_index for a single
752
+ request; this effectively ignores the host_index
753
+ in the spec for a single request.
754
+ :type _host_index: int, optional
755
+ :return: Returns the result object.
756
+ """ # noqa: E501
757
+
758
+ _param = self._regenerate_entity_observations_serialize(
759
+ bank_id=bank_id,
760
+ entity_id=entity_id,
761
+ authorization=authorization,
762
+ _request_auth=_request_auth,
763
+ _content_type=_content_type,
764
+ _headers=_headers,
765
+ _host_index=_host_index
766
+ )
767
+
768
+ _response_types_map: Dict[str, Optional[str]] = {
769
+ '200': "EntityDetailResponse",
770
+ '422': "HTTPValidationError",
771
+ }
772
+ response_data = await self.api_client.call_api(
773
+ *_param,
774
+ _request_timeout=_request_timeout
775
+ )
776
+ await response_data.read()
777
+ return self.api_client.response_deserialize(
778
+ response_data=response_data,
779
+ response_types_map=_response_types_map,
780
+ )
781
+
782
+
783
+ @validate_call
784
+ async def regenerate_entity_observations_without_preload_content(
785
+ self,
786
+ bank_id: StrictStr,
787
+ entity_id: StrictStr,
788
+ authorization: Optional[StrictStr] = None,
789
+ _request_timeout: Union[
790
+ None,
791
+ Annotated[StrictFloat, Field(gt=0)],
792
+ Tuple[
793
+ Annotated[StrictFloat, Field(gt=0)],
794
+ Annotated[StrictFloat, Field(gt=0)]
795
+ ]
796
+ ] = None,
797
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
798
+ _content_type: Optional[StrictStr] = None,
799
+ _headers: Optional[Dict[StrictStr, Any]] = None,
800
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
801
+ ) -> RESTResponseType:
802
+ """Regenerate entity observations
803
+
804
+ Regenerate observations for an entity based on all facts mentioning it.
805
+
806
+ :param bank_id: (required)
807
+ :type bank_id: str
808
+ :param entity_id: (required)
809
+ :type entity_id: str
810
+ :param authorization:
811
+ :type authorization: str
812
+ :param _request_timeout: timeout setting for this request. If one
813
+ number provided, it will be total request
814
+ timeout. It can also be a pair (tuple) of
815
+ (connection, read) timeouts.
816
+ :type _request_timeout: int, tuple(int, int), optional
817
+ :param _request_auth: set to override the auth_settings for an a single
818
+ request; this effectively ignores the
819
+ authentication in the spec for a single request.
820
+ :type _request_auth: dict, optional
821
+ :param _content_type: force content-type for the request.
822
+ :type _content_type: str, Optional
823
+ :param _headers: set to override the headers for a single
824
+ request; this effectively ignores the headers
825
+ in the spec for a single request.
826
+ :type _headers: dict, optional
827
+ :param _host_index: set to override the host_index for a single
828
+ request; this effectively ignores the host_index
829
+ in the spec for a single request.
830
+ :type _host_index: int, optional
831
+ :return: Returns the result object.
832
+ """ # noqa: E501
833
+
834
+ _param = self._regenerate_entity_observations_serialize(
835
+ bank_id=bank_id,
836
+ entity_id=entity_id,
837
+ authorization=authorization,
838
+ _request_auth=_request_auth,
839
+ _content_type=_content_type,
840
+ _headers=_headers,
841
+ _host_index=_host_index
842
+ )
843
+
844
+ _response_types_map: Dict[str, Optional[str]] = {
845
+ '200': "EntityDetailResponse",
846
+ '422': "HTTPValidationError",
847
+ }
848
+ response_data = await self.api_client.call_api(
849
+ *_param,
850
+ _request_timeout=_request_timeout
851
+ )
852
+ return response_data.response
853
+
854
+
855
+ def _regenerate_entity_observations_serialize(
856
+ self,
857
+ bank_id,
858
+ entity_id,
859
+ authorization,
860
+ _request_auth,
861
+ _content_type,
862
+ _headers,
863
+ _host_index,
864
+ ) -> RequestSerialized:
865
+
866
+ _host = None
867
+
868
+ _collection_formats: Dict[str, str] = {
869
+ }
870
+
871
+ _path_params: Dict[str, str] = {}
872
+ _query_params: List[Tuple[str, str]] = []
873
+ _header_params: Dict[str, Optional[str]] = _headers or {}
874
+ _form_params: List[Tuple[str, str]] = []
875
+ _files: Dict[
876
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
877
+ ] = {}
878
+ _body_params: Optional[bytes] = None
879
+
880
+ # process the path parameters
881
+ if bank_id is not None:
882
+ _path_params['bank_id'] = bank_id
883
+ if entity_id is not None:
884
+ _path_params['entity_id'] = entity_id
885
+ # process the query parameters
886
+ # process the header parameters
887
+ if authorization is not None:
888
+ _header_params['authorization'] = authorization
889
+ # process the form parameters
890
+ # process the body parameter
891
+
892
+
893
+ # set the HTTP header `Accept`
894
+ if 'Accept' not in _header_params:
895
+ _header_params['Accept'] = self.api_client.select_header_accept(
896
+ [
897
+ 'application/json'
898
+ ]
899
+ )
900
+
901
+
902
+ # authentication setting
903
+ _auth_settings: List[str] = [
904
+ ]
905
+
906
+ return self.api_client.param_serialize(
907
+ method='POST',
908
+ resource_path='/v1/default/banks/{bank_id}/entities/{entity_id}/regenerate',
909
+ path_params=_path_params,
910
+ query_params=_query_params,
911
+ header_params=_header_params,
912
+ body=_body_params,
913
+ post_params=_form_params,
914
+ files=_files,
915
+ auth_settings=_auth_settings,
916
+ collection_formats=_collection_formats,
917
+ _host=_host,
918
+ _request_auth=_request_auth
919
+ )
920
+
921
+