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
@@ -1,1568 +0,0 @@
1
- # hindsight_client_api.DefaultApi
2
-
3
- All URIs are relative to *http://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**add_bank_background**](DefaultApi.md#add_bank_background) | **POST** /v1/default/banks/{bank_id}/background | Add/merge memory bank background
8
- [**cancel_operation**](DefaultApi.md#cancel_operation) | **DELETE** /v1/default/banks/{bank_id}/operations/{operation_id} | Cancel a pending async operation
9
- [**clear_bank_memories**](DefaultApi.md#clear_bank_memories) | **DELETE** /v1/default/banks/{bank_id}/memories | Clear memory bank memories
10
- [**create_or_update_bank**](DefaultApi.md#create_or_update_bank) | **PUT** /v1/default/banks/{bank_id} | Create or update memory bank
11
- [**delete_document**](DefaultApi.md#delete_document) | **DELETE** /v1/default/banks/{bank_id}/documents/{document_id} | Delete a document
12
- [**get_agent_stats**](DefaultApi.md#get_agent_stats) | **GET** /v1/default/banks/{bank_id}/stats | Get statistics for memory bank
13
- [**get_bank_profile**](DefaultApi.md#get_bank_profile) | **GET** /v1/default/banks/{bank_id}/profile | Get memory bank profile
14
- [**get_chunk**](DefaultApi.md#get_chunk) | **GET** /v1/default/chunks/{chunk_id} | Get chunk details
15
- [**get_document**](DefaultApi.md#get_document) | **GET** /v1/default/banks/{bank_id}/documents/{document_id} | Get document details
16
- [**get_entity**](DefaultApi.md#get_entity) | **GET** /v1/default/banks/{bank_id}/entities/{entity_id} | Get entity details
17
- [**get_graph**](DefaultApi.md#get_graph) | **GET** /v1/default/banks/{bank_id}/graph | Get memory graph data
18
- [**list_banks**](DefaultApi.md#list_banks) | **GET** /v1/default/banks | List all memory banks
19
- [**list_documents**](DefaultApi.md#list_documents) | **GET** /v1/default/banks/{bank_id}/documents | List documents
20
- [**list_entities**](DefaultApi.md#list_entities) | **GET** /v1/default/banks/{bank_id}/entities | List entities
21
- [**list_memories**](DefaultApi.md#list_memories) | **GET** /v1/default/banks/{bank_id}/memories/list | List memory units
22
- [**list_operations**](DefaultApi.md#list_operations) | **GET** /v1/default/banks/{bank_id}/operations | List async operations
23
- [**recall_memories**](DefaultApi.md#recall_memories) | **POST** /v1/default/banks/{bank_id}/memories/recall | Recall memory
24
- [**reflect**](DefaultApi.md#reflect) | **POST** /v1/default/banks/{bank_id}/reflect | Reflect and generate answer
25
- [**regenerate_entity_observations**](DefaultApi.md#regenerate_entity_observations) | **POST** /v1/default/banks/{bank_id}/entities/{entity_id}/regenerate | Regenerate entity observations
26
- [**retain_memories**](DefaultApi.md#retain_memories) | **POST** /v1/default/banks/{bank_id}/memories | Retain memories
27
- [**update_bank_disposition**](DefaultApi.md#update_bank_disposition) | **PUT** /v1/default/banks/{bank_id}/profile | Update memory bank disposition
28
-
29
-
30
- # **add_bank_background**
31
- > BackgroundResponse add_bank_background(bank_id, add_background_request)
32
-
33
- Add/merge memory bank background
34
-
35
- Add new background information or merge with existing. LLM intelligently resolves conflicts, normalizes to first person, and optionally infers disposition traits.
36
-
37
- ### Example
38
-
39
-
40
- ```python
41
- import hindsight_client_api
42
- from hindsight_client_api.models.add_background_request import AddBackgroundRequest
43
- from hindsight_client_api.models.background_response import BackgroundResponse
44
- from hindsight_client_api.rest import ApiException
45
- from pprint import pprint
46
-
47
- # Defining the host is optional and defaults to http://localhost
48
- # See configuration.py for a list of all supported configuration parameters.
49
- configuration = hindsight_client_api.Configuration(
50
- host = "http://localhost"
51
- )
52
-
53
-
54
- # Enter a context with an instance of the API client
55
- async with hindsight_client_api.ApiClient(configuration) as api_client:
56
- # Create an instance of the API class
57
- api_instance = hindsight_client_api.DefaultApi(api_client)
58
- bank_id = 'bank_id_example' # str |
59
- add_background_request = hindsight_client_api.AddBackgroundRequest() # AddBackgroundRequest |
60
-
61
- try:
62
- # Add/merge memory bank background
63
- api_response = await api_instance.add_bank_background(bank_id, add_background_request)
64
- print("The response of DefaultApi->add_bank_background:\n")
65
- pprint(api_response)
66
- except Exception as e:
67
- print("Exception when calling DefaultApi->add_bank_background: %s\n" % e)
68
- ```
69
-
70
-
71
-
72
- ### Parameters
73
-
74
-
75
- Name | Type | Description | Notes
76
- ------------- | ------------- | ------------- | -------------
77
- **bank_id** | **str**| |
78
- **add_background_request** | [**AddBackgroundRequest**](AddBackgroundRequest.md)| |
79
-
80
- ### Return type
81
-
82
- [**BackgroundResponse**](BackgroundResponse.md)
83
-
84
- ### Authorization
85
-
86
- No authorization required
87
-
88
- ### HTTP request headers
89
-
90
- - **Content-Type**: application/json
91
- - **Accept**: application/json
92
-
93
- ### HTTP response details
94
-
95
- | Status code | Description | Response headers |
96
- |-------------|-------------|------------------|
97
- **200** | Successful Response | - |
98
- **422** | Validation Error | - |
99
-
100
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
101
-
102
- # **cancel_operation**
103
- > object cancel_operation(bank_id, operation_id)
104
-
105
- Cancel a pending async operation
106
-
107
- Cancel a pending async operation by removing it from the queue
108
-
109
- ### Example
110
-
111
-
112
- ```python
113
- import hindsight_client_api
114
- from hindsight_client_api.rest import ApiException
115
- from pprint import pprint
116
-
117
- # Defining the host is optional and defaults to http://localhost
118
- # See configuration.py for a list of all supported configuration parameters.
119
- configuration = hindsight_client_api.Configuration(
120
- host = "http://localhost"
121
- )
122
-
123
-
124
- # Enter a context with an instance of the API client
125
- async with hindsight_client_api.ApiClient(configuration) as api_client:
126
- # Create an instance of the API class
127
- api_instance = hindsight_client_api.DefaultApi(api_client)
128
- bank_id = 'bank_id_example' # str |
129
- operation_id = 'operation_id_example' # str |
130
-
131
- try:
132
- # Cancel a pending async operation
133
- api_response = await api_instance.cancel_operation(bank_id, operation_id)
134
- print("The response of DefaultApi->cancel_operation:\n")
135
- pprint(api_response)
136
- except Exception as e:
137
- print("Exception when calling DefaultApi->cancel_operation: %s\n" % e)
138
- ```
139
-
140
-
141
-
142
- ### Parameters
143
-
144
-
145
- Name | Type | Description | Notes
146
- ------------- | ------------- | ------------- | -------------
147
- **bank_id** | **str**| |
148
- **operation_id** | **str**| |
149
-
150
- ### Return type
151
-
152
- **object**
153
-
154
- ### Authorization
155
-
156
- No authorization required
157
-
158
- ### HTTP request headers
159
-
160
- - **Content-Type**: Not defined
161
- - **Accept**: application/json
162
-
163
- ### HTTP response details
164
-
165
- | Status code | Description | Response headers |
166
- |-------------|-------------|------------------|
167
- **200** | Successful Response | - |
168
- **422** | Validation Error | - |
169
-
170
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
171
-
172
- # **clear_bank_memories**
173
- > DeleteResponse clear_bank_memories(bank_id, type=type)
174
-
175
- Clear memory bank memories
176
-
177
- Delete memory units for a memory bank. Optionally filter by type (world, experience, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (disposition and background) will be preserved.
178
-
179
- ### Example
180
-
181
-
182
- ```python
183
- import hindsight_client_api
184
- from hindsight_client_api.models.delete_response import DeleteResponse
185
- from hindsight_client_api.rest import ApiException
186
- from pprint import pprint
187
-
188
- # Defining the host is optional and defaults to http://localhost
189
- # See configuration.py for a list of all supported configuration parameters.
190
- configuration = hindsight_client_api.Configuration(
191
- host = "http://localhost"
192
- )
193
-
194
-
195
- # Enter a context with an instance of the API client
196
- async with hindsight_client_api.ApiClient(configuration) as api_client:
197
- # Create an instance of the API class
198
- api_instance = hindsight_client_api.DefaultApi(api_client)
199
- bank_id = 'bank_id_example' # str |
200
- type = 'type_example' # str | Optional fact type filter (world, experience, opinion) (optional)
201
-
202
- try:
203
- # Clear memory bank memories
204
- api_response = await api_instance.clear_bank_memories(bank_id, type=type)
205
- print("The response of DefaultApi->clear_bank_memories:\n")
206
- pprint(api_response)
207
- except Exception as e:
208
- print("Exception when calling DefaultApi->clear_bank_memories: %s\n" % e)
209
- ```
210
-
211
-
212
-
213
- ### Parameters
214
-
215
-
216
- Name | Type | Description | Notes
217
- ------------- | ------------- | ------------- | -------------
218
- **bank_id** | **str**| |
219
- **type** | **str**| Optional fact type filter (world, experience, opinion) | [optional]
220
-
221
- ### Return type
222
-
223
- [**DeleteResponse**](DeleteResponse.md)
224
-
225
- ### Authorization
226
-
227
- No authorization required
228
-
229
- ### HTTP request headers
230
-
231
- - **Content-Type**: Not defined
232
- - **Accept**: application/json
233
-
234
- ### HTTP response details
235
-
236
- | Status code | Description | Response headers |
237
- |-------------|-------------|------------------|
238
- **200** | Successful Response | - |
239
- **422** | Validation Error | - |
240
-
241
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
242
-
243
- # **create_or_update_bank**
244
- > BankProfileResponse create_or_update_bank(bank_id, create_bank_request)
245
-
246
- Create or update memory bank
247
-
248
- Create a new agent or update existing agent with disposition and background. Auto-fills missing fields with defaults.
249
-
250
- ### Example
251
-
252
-
253
- ```python
254
- import hindsight_client_api
255
- from hindsight_client_api.models.bank_profile_response import BankProfileResponse
256
- from hindsight_client_api.models.create_bank_request import CreateBankRequest
257
- from hindsight_client_api.rest import ApiException
258
- from pprint import pprint
259
-
260
- # Defining the host is optional and defaults to http://localhost
261
- # See configuration.py for a list of all supported configuration parameters.
262
- configuration = hindsight_client_api.Configuration(
263
- host = "http://localhost"
264
- )
265
-
266
-
267
- # Enter a context with an instance of the API client
268
- async with hindsight_client_api.ApiClient(configuration) as api_client:
269
- # Create an instance of the API class
270
- api_instance = hindsight_client_api.DefaultApi(api_client)
271
- bank_id = 'bank_id_example' # str |
272
- create_bank_request = hindsight_client_api.CreateBankRequest() # CreateBankRequest |
273
-
274
- try:
275
- # Create or update memory bank
276
- api_response = await api_instance.create_or_update_bank(bank_id, create_bank_request)
277
- print("The response of DefaultApi->create_or_update_bank:\n")
278
- pprint(api_response)
279
- except Exception as e:
280
- print("Exception when calling DefaultApi->create_or_update_bank: %s\n" % e)
281
- ```
282
-
283
-
284
-
285
- ### Parameters
286
-
287
-
288
- Name | Type | Description | Notes
289
- ------------- | ------------- | ------------- | -------------
290
- **bank_id** | **str**| |
291
- **create_bank_request** | [**CreateBankRequest**](CreateBankRequest.md)| |
292
-
293
- ### Return type
294
-
295
- [**BankProfileResponse**](BankProfileResponse.md)
296
-
297
- ### Authorization
298
-
299
- No authorization required
300
-
301
- ### HTTP request headers
302
-
303
- - **Content-Type**: application/json
304
- - **Accept**: application/json
305
-
306
- ### HTTP response details
307
-
308
- | Status code | Description | Response headers |
309
- |-------------|-------------|------------------|
310
- **200** | Successful Response | - |
311
- **422** | Validation Error | - |
312
-
313
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
314
-
315
- # **delete_document**
316
- > object delete_document(bank_id, document_id)
317
-
318
- Delete a document
319
-
320
- Delete a document and all its associated memory units and links.
321
-
322
- This will cascade delete:
323
- - The document itself
324
- - All memory units extracted from this document
325
- - All links (temporal, semantic, entity) associated with those memory units
326
-
327
- This operation cannot be undone.
328
-
329
- ### Example
330
-
331
-
332
- ```python
333
- import hindsight_client_api
334
- from hindsight_client_api.rest import ApiException
335
- from pprint import pprint
336
-
337
- # Defining the host is optional and defaults to http://localhost
338
- # See configuration.py for a list of all supported configuration parameters.
339
- configuration = hindsight_client_api.Configuration(
340
- host = "http://localhost"
341
- )
342
-
343
-
344
- # Enter a context with an instance of the API client
345
- async with hindsight_client_api.ApiClient(configuration) as api_client:
346
- # Create an instance of the API class
347
- api_instance = hindsight_client_api.DefaultApi(api_client)
348
- bank_id = 'bank_id_example' # str |
349
- document_id = 'document_id_example' # str |
350
-
351
- try:
352
- # Delete a document
353
- api_response = await api_instance.delete_document(bank_id, document_id)
354
- print("The response of DefaultApi->delete_document:\n")
355
- pprint(api_response)
356
- except Exception as e:
357
- print("Exception when calling DefaultApi->delete_document: %s\n" % e)
358
- ```
359
-
360
-
361
-
362
- ### Parameters
363
-
364
-
365
- Name | Type | Description | Notes
366
- ------------- | ------------- | ------------- | -------------
367
- **bank_id** | **str**| |
368
- **document_id** | **str**| |
369
-
370
- ### Return type
371
-
372
- **object**
373
-
374
- ### Authorization
375
-
376
- No authorization required
377
-
378
- ### HTTP request headers
379
-
380
- - **Content-Type**: Not defined
381
- - **Accept**: application/json
382
-
383
- ### HTTP response details
384
-
385
- | Status code | Description | Response headers |
386
- |-------------|-------------|------------------|
387
- **200** | Successful Response | - |
388
- **422** | Validation Error | - |
389
-
390
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
391
-
392
- # **get_agent_stats**
393
- > object get_agent_stats(bank_id)
394
-
395
- Get statistics for memory bank
396
-
397
- Get statistics about nodes and links for a specific agent
398
-
399
- ### Example
400
-
401
-
402
- ```python
403
- import hindsight_client_api
404
- from hindsight_client_api.rest import ApiException
405
- from pprint import pprint
406
-
407
- # Defining the host is optional and defaults to http://localhost
408
- # See configuration.py for a list of all supported configuration parameters.
409
- configuration = hindsight_client_api.Configuration(
410
- host = "http://localhost"
411
- )
412
-
413
-
414
- # Enter a context with an instance of the API client
415
- async with hindsight_client_api.ApiClient(configuration) as api_client:
416
- # Create an instance of the API class
417
- api_instance = hindsight_client_api.DefaultApi(api_client)
418
- bank_id = 'bank_id_example' # str |
419
-
420
- try:
421
- # Get statistics for memory bank
422
- api_response = await api_instance.get_agent_stats(bank_id)
423
- print("The response of DefaultApi->get_agent_stats:\n")
424
- pprint(api_response)
425
- except Exception as e:
426
- print("Exception when calling DefaultApi->get_agent_stats: %s\n" % e)
427
- ```
428
-
429
-
430
-
431
- ### Parameters
432
-
433
-
434
- Name | Type | Description | Notes
435
- ------------- | ------------- | ------------- | -------------
436
- **bank_id** | **str**| |
437
-
438
- ### Return type
439
-
440
- **object**
441
-
442
- ### Authorization
443
-
444
- No authorization required
445
-
446
- ### HTTP request headers
447
-
448
- - **Content-Type**: Not defined
449
- - **Accept**: application/json
450
-
451
- ### HTTP response details
452
-
453
- | Status code | Description | Response headers |
454
- |-------------|-------------|------------------|
455
- **200** | Successful Response | - |
456
- **422** | Validation Error | - |
457
-
458
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
459
-
460
- # **get_bank_profile**
461
- > BankProfileResponse get_bank_profile(bank_id)
462
-
463
- Get memory bank profile
464
-
465
- Get disposition traits and background for a memory bank. Auto-creates agent with defaults if not exists.
466
-
467
- ### Example
468
-
469
-
470
- ```python
471
- import hindsight_client_api
472
- from hindsight_client_api.models.bank_profile_response import BankProfileResponse
473
- from hindsight_client_api.rest import ApiException
474
- from pprint import pprint
475
-
476
- # Defining the host is optional and defaults to http://localhost
477
- # See configuration.py for a list of all supported configuration parameters.
478
- configuration = hindsight_client_api.Configuration(
479
- host = "http://localhost"
480
- )
481
-
482
-
483
- # Enter a context with an instance of the API client
484
- async with hindsight_client_api.ApiClient(configuration) as api_client:
485
- # Create an instance of the API class
486
- api_instance = hindsight_client_api.DefaultApi(api_client)
487
- bank_id = 'bank_id_example' # str |
488
-
489
- try:
490
- # Get memory bank profile
491
- api_response = await api_instance.get_bank_profile(bank_id)
492
- print("The response of DefaultApi->get_bank_profile:\n")
493
- pprint(api_response)
494
- except Exception as e:
495
- print("Exception when calling DefaultApi->get_bank_profile: %s\n" % e)
496
- ```
497
-
498
-
499
-
500
- ### Parameters
501
-
502
-
503
- Name | Type | Description | Notes
504
- ------------- | ------------- | ------------- | -------------
505
- **bank_id** | **str**| |
506
-
507
- ### Return type
508
-
509
- [**BankProfileResponse**](BankProfileResponse.md)
510
-
511
- ### Authorization
512
-
513
- No authorization required
514
-
515
- ### HTTP request headers
516
-
517
- - **Content-Type**: Not defined
518
- - **Accept**: application/json
519
-
520
- ### HTTP response details
521
-
522
- | Status code | Description | Response headers |
523
- |-------------|-------------|------------------|
524
- **200** | Successful Response | - |
525
- **422** | Validation Error | - |
526
-
527
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
528
-
529
- # **get_chunk**
530
- > ChunkResponse get_chunk(chunk_id)
531
-
532
- Get chunk details
533
-
534
- Get a specific chunk by its ID
535
-
536
- ### Example
537
-
538
-
539
- ```python
540
- import hindsight_client_api
541
- from hindsight_client_api.models.chunk_response import ChunkResponse
542
- from hindsight_client_api.rest import ApiException
543
- from pprint import pprint
544
-
545
- # Defining the host is optional and defaults to http://localhost
546
- # See configuration.py for a list of all supported configuration parameters.
547
- configuration = hindsight_client_api.Configuration(
548
- host = "http://localhost"
549
- )
550
-
551
-
552
- # Enter a context with an instance of the API client
553
- async with hindsight_client_api.ApiClient(configuration) as api_client:
554
- # Create an instance of the API class
555
- api_instance = hindsight_client_api.DefaultApi(api_client)
556
- chunk_id = 'chunk_id_example' # str |
557
-
558
- try:
559
- # Get chunk details
560
- api_response = await api_instance.get_chunk(chunk_id)
561
- print("The response of DefaultApi->get_chunk:\n")
562
- pprint(api_response)
563
- except Exception as e:
564
- print("Exception when calling DefaultApi->get_chunk: %s\n" % e)
565
- ```
566
-
567
-
568
-
569
- ### Parameters
570
-
571
-
572
- Name | Type | Description | Notes
573
- ------------- | ------------- | ------------- | -------------
574
- **chunk_id** | **str**| |
575
-
576
- ### Return type
577
-
578
- [**ChunkResponse**](ChunkResponse.md)
579
-
580
- ### Authorization
581
-
582
- No authorization required
583
-
584
- ### HTTP request headers
585
-
586
- - **Content-Type**: Not defined
587
- - **Accept**: application/json
588
-
589
- ### HTTP response details
590
-
591
- | Status code | Description | Response headers |
592
- |-------------|-------------|------------------|
593
- **200** | Successful Response | - |
594
- **422** | Validation Error | - |
595
-
596
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
597
-
598
- # **get_document**
599
- > DocumentResponse get_document(bank_id, document_id)
600
-
601
- Get document details
602
-
603
- Get a specific document including its original text
604
-
605
- ### Example
606
-
607
-
608
- ```python
609
- import hindsight_client_api
610
- from hindsight_client_api.models.document_response import DocumentResponse
611
- from hindsight_client_api.rest import ApiException
612
- from pprint import pprint
613
-
614
- # Defining the host is optional and defaults to http://localhost
615
- # See configuration.py for a list of all supported configuration parameters.
616
- configuration = hindsight_client_api.Configuration(
617
- host = "http://localhost"
618
- )
619
-
620
-
621
- # Enter a context with an instance of the API client
622
- async with hindsight_client_api.ApiClient(configuration) as api_client:
623
- # Create an instance of the API class
624
- api_instance = hindsight_client_api.DefaultApi(api_client)
625
- bank_id = 'bank_id_example' # str |
626
- document_id = 'document_id_example' # str |
627
-
628
- try:
629
- # Get document details
630
- api_response = await api_instance.get_document(bank_id, document_id)
631
- print("The response of DefaultApi->get_document:\n")
632
- pprint(api_response)
633
- except Exception as e:
634
- print("Exception when calling DefaultApi->get_document: %s\n" % e)
635
- ```
636
-
637
-
638
-
639
- ### Parameters
640
-
641
-
642
- Name | Type | Description | Notes
643
- ------------- | ------------- | ------------- | -------------
644
- **bank_id** | **str**| |
645
- **document_id** | **str**| |
646
-
647
- ### Return type
648
-
649
- [**DocumentResponse**](DocumentResponse.md)
650
-
651
- ### Authorization
652
-
653
- No authorization required
654
-
655
- ### HTTP request headers
656
-
657
- - **Content-Type**: Not defined
658
- - **Accept**: application/json
659
-
660
- ### HTTP response details
661
-
662
- | Status code | Description | Response headers |
663
- |-------------|-------------|------------------|
664
- **200** | Successful Response | - |
665
- **422** | Validation Error | - |
666
-
667
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
668
-
669
- # **get_entity**
670
- > EntityDetailResponse get_entity(bank_id, entity_id)
671
-
672
- Get entity details
673
-
674
- Get detailed information about an entity including observations (mental model).
675
-
676
- ### Example
677
-
678
-
679
- ```python
680
- import hindsight_client_api
681
- from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
682
- from hindsight_client_api.rest import ApiException
683
- from pprint import pprint
684
-
685
- # Defining the host is optional and defaults to http://localhost
686
- # See configuration.py for a list of all supported configuration parameters.
687
- configuration = hindsight_client_api.Configuration(
688
- host = "http://localhost"
689
- )
690
-
691
-
692
- # Enter a context with an instance of the API client
693
- async with hindsight_client_api.ApiClient(configuration) as api_client:
694
- # Create an instance of the API class
695
- api_instance = hindsight_client_api.DefaultApi(api_client)
696
- bank_id = 'bank_id_example' # str |
697
- entity_id = 'entity_id_example' # str |
698
-
699
- try:
700
- # Get entity details
701
- api_response = await api_instance.get_entity(bank_id, entity_id)
702
- print("The response of DefaultApi->get_entity:\n")
703
- pprint(api_response)
704
- except Exception as e:
705
- print("Exception when calling DefaultApi->get_entity: %s\n" % e)
706
- ```
707
-
708
-
709
-
710
- ### Parameters
711
-
712
-
713
- Name | Type | Description | Notes
714
- ------------- | ------------- | ------------- | -------------
715
- **bank_id** | **str**| |
716
- **entity_id** | **str**| |
717
-
718
- ### Return type
719
-
720
- [**EntityDetailResponse**](EntityDetailResponse.md)
721
-
722
- ### Authorization
723
-
724
- No authorization required
725
-
726
- ### HTTP request headers
727
-
728
- - **Content-Type**: Not defined
729
- - **Accept**: application/json
730
-
731
- ### HTTP response details
732
-
733
- | Status code | Description | Response headers |
734
- |-------------|-------------|------------------|
735
- **200** | Successful Response | - |
736
- **422** | Validation Error | - |
737
-
738
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
739
-
740
- # **get_graph**
741
- > GraphDataResponse get_graph(bank_id, type=type)
742
-
743
- Get memory graph data
744
-
745
- Retrieve graph data for visualization, optionally filtered by type (world/experience/opinion). Limited to 1000 most recent items.
746
-
747
- ### Example
748
-
749
-
750
- ```python
751
- import hindsight_client_api
752
- from hindsight_client_api.models.graph_data_response import GraphDataResponse
753
- from hindsight_client_api.rest import ApiException
754
- from pprint import pprint
755
-
756
- # Defining the host is optional and defaults to http://localhost
757
- # See configuration.py for a list of all supported configuration parameters.
758
- configuration = hindsight_client_api.Configuration(
759
- host = "http://localhost"
760
- )
761
-
762
-
763
- # Enter a context with an instance of the API client
764
- async with hindsight_client_api.ApiClient(configuration) as api_client:
765
- # Create an instance of the API class
766
- api_instance = hindsight_client_api.DefaultApi(api_client)
767
- bank_id = 'bank_id_example' # str |
768
- type = 'type_example' # str | (optional)
769
-
770
- try:
771
- # Get memory graph data
772
- api_response = await api_instance.get_graph(bank_id, type=type)
773
- print("The response of DefaultApi->get_graph:\n")
774
- pprint(api_response)
775
- except Exception as e:
776
- print("Exception when calling DefaultApi->get_graph: %s\n" % e)
777
- ```
778
-
779
-
780
-
781
- ### Parameters
782
-
783
-
784
- Name | Type | Description | Notes
785
- ------------- | ------------- | ------------- | -------------
786
- **bank_id** | **str**| |
787
- **type** | **str**| | [optional]
788
-
789
- ### Return type
790
-
791
- [**GraphDataResponse**](GraphDataResponse.md)
792
-
793
- ### Authorization
794
-
795
- No authorization required
796
-
797
- ### HTTP request headers
798
-
799
- - **Content-Type**: Not defined
800
- - **Accept**: application/json
801
-
802
- ### HTTP response details
803
-
804
- | Status code | Description | Response headers |
805
- |-------------|-------------|------------------|
806
- **200** | Successful Response | - |
807
- **422** | Validation Error | - |
808
-
809
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
810
-
811
- # **list_banks**
812
- > BankListResponse list_banks()
813
-
814
- List all memory banks
815
-
816
- Get a list of all agents with their profiles
817
-
818
- ### Example
819
-
820
-
821
- ```python
822
- import hindsight_client_api
823
- from hindsight_client_api.models.bank_list_response import BankListResponse
824
- from hindsight_client_api.rest import ApiException
825
- from pprint import pprint
826
-
827
- # Defining the host is optional and defaults to http://localhost
828
- # See configuration.py for a list of all supported configuration parameters.
829
- configuration = hindsight_client_api.Configuration(
830
- host = "http://localhost"
831
- )
832
-
833
-
834
- # Enter a context with an instance of the API client
835
- async with hindsight_client_api.ApiClient(configuration) as api_client:
836
- # Create an instance of the API class
837
- api_instance = hindsight_client_api.DefaultApi(api_client)
838
-
839
- try:
840
- # List all memory banks
841
- api_response = await api_instance.list_banks()
842
- print("The response of DefaultApi->list_banks:\n")
843
- pprint(api_response)
844
- except Exception as e:
845
- print("Exception when calling DefaultApi->list_banks: %s\n" % e)
846
- ```
847
-
848
-
849
-
850
- ### Parameters
851
-
852
- This endpoint does not need any parameter.
853
-
854
- ### Return type
855
-
856
- [**BankListResponse**](BankListResponse.md)
857
-
858
- ### Authorization
859
-
860
- No authorization required
861
-
862
- ### HTTP request headers
863
-
864
- - **Content-Type**: Not defined
865
- - **Accept**: application/json
866
-
867
- ### HTTP response details
868
-
869
- | Status code | Description | Response headers |
870
- |-------------|-------------|------------------|
871
- **200** | Successful Response | - |
872
-
873
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
874
-
875
- # **list_documents**
876
- > ListDocumentsResponse list_documents(bank_id, q=q, limit=limit, offset=offset)
877
-
878
- List documents
879
-
880
- List documents with pagination and optional search. Documents are the source content from which memory units are extracted.
881
-
882
- ### Example
883
-
884
-
885
- ```python
886
- import hindsight_client_api
887
- from hindsight_client_api.models.list_documents_response import ListDocumentsResponse
888
- from hindsight_client_api.rest import ApiException
889
- from pprint import pprint
890
-
891
- # Defining the host is optional and defaults to http://localhost
892
- # See configuration.py for a list of all supported configuration parameters.
893
- configuration = hindsight_client_api.Configuration(
894
- host = "http://localhost"
895
- )
896
-
897
-
898
- # Enter a context with an instance of the API client
899
- async with hindsight_client_api.ApiClient(configuration) as api_client:
900
- # Create an instance of the API class
901
- api_instance = hindsight_client_api.DefaultApi(api_client)
902
- bank_id = 'bank_id_example' # str |
903
- q = 'q_example' # str | (optional)
904
- limit = 100 # int | (optional) (default to 100)
905
- offset = 0 # int | (optional) (default to 0)
906
-
907
- try:
908
- # List documents
909
- api_response = await api_instance.list_documents(bank_id, q=q, limit=limit, offset=offset)
910
- print("The response of DefaultApi->list_documents:\n")
911
- pprint(api_response)
912
- except Exception as e:
913
- print("Exception when calling DefaultApi->list_documents: %s\n" % e)
914
- ```
915
-
916
-
917
-
918
- ### Parameters
919
-
920
-
921
- Name | Type | Description | Notes
922
- ------------- | ------------- | ------------- | -------------
923
- **bank_id** | **str**| |
924
- **q** | **str**| | [optional]
925
- **limit** | **int**| | [optional] [default to 100]
926
- **offset** | **int**| | [optional] [default to 0]
927
-
928
- ### Return type
929
-
930
- [**ListDocumentsResponse**](ListDocumentsResponse.md)
931
-
932
- ### Authorization
933
-
934
- No authorization required
935
-
936
- ### HTTP request headers
937
-
938
- - **Content-Type**: Not defined
939
- - **Accept**: application/json
940
-
941
- ### HTTP response details
942
-
943
- | Status code | Description | Response headers |
944
- |-------------|-------------|------------------|
945
- **200** | Successful Response | - |
946
- **422** | Validation Error | - |
947
-
948
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
949
-
950
- # **list_entities**
951
- > EntityListResponse list_entities(bank_id, limit=limit)
952
-
953
- List entities
954
-
955
- List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
956
-
957
- ### Example
958
-
959
-
960
- ```python
961
- import hindsight_client_api
962
- from hindsight_client_api.models.entity_list_response import EntityListResponse
963
- from hindsight_client_api.rest import ApiException
964
- from pprint import pprint
965
-
966
- # Defining the host is optional and defaults to http://localhost
967
- # See configuration.py for a list of all supported configuration parameters.
968
- configuration = hindsight_client_api.Configuration(
969
- host = "http://localhost"
970
- )
971
-
972
-
973
- # Enter a context with an instance of the API client
974
- async with hindsight_client_api.ApiClient(configuration) as api_client:
975
- # Create an instance of the API class
976
- api_instance = hindsight_client_api.DefaultApi(api_client)
977
- bank_id = 'bank_id_example' # str |
978
- limit = 100 # int | Maximum number of entities to return (optional) (default to 100)
979
-
980
- try:
981
- # List entities
982
- api_response = await api_instance.list_entities(bank_id, limit=limit)
983
- print("The response of DefaultApi->list_entities:\n")
984
- pprint(api_response)
985
- except Exception as e:
986
- print("Exception when calling DefaultApi->list_entities: %s\n" % e)
987
- ```
988
-
989
-
990
-
991
- ### Parameters
992
-
993
-
994
- Name | Type | Description | Notes
995
- ------------- | ------------- | ------------- | -------------
996
- **bank_id** | **str**| |
997
- **limit** | **int**| Maximum number of entities to return | [optional] [default to 100]
998
-
999
- ### Return type
1000
-
1001
- [**EntityListResponse**](EntityListResponse.md)
1002
-
1003
- ### Authorization
1004
-
1005
- No authorization required
1006
-
1007
- ### HTTP request headers
1008
-
1009
- - **Content-Type**: Not defined
1010
- - **Accept**: application/json
1011
-
1012
- ### HTTP response details
1013
-
1014
- | Status code | Description | Response headers |
1015
- |-------------|-------------|------------------|
1016
- **200** | Successful Response | - |
1017
- **422** | Validation Error | - |
1018
-
1019
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1020
-
1021
- # **list_memories**
1022
- > ListMemoryUnitsResponse list_memories(bank_id, type=type, q=q, limit=limit, offset=offset)
1023
-
1024
- List memory units
1025
-
1026
- List memory units with pagination and optional full-text search. Supports filtering by type. Results are sorted by most recent first (mentioned_at DESC, then created_at DESC).
1027
-
1028
- ### Example
1029
-
1030
-
1031
- ```python
1032
- import hindsight_client_api
1033
- from hindsight_client_api.models.list_memory_units_response import ListMemoryUnitsResponse
1034
- from hindsight_client_api.rest import ApiException
1035
- from pprint import pprint
1036
-
1037
- # Defining the host is optional and defaults to http://localhost
1038
- # See configuration.py for a list of all supported configuration parameters.
1039
- configuration = hindsight_client_api.Configuration(
1040
- host = "http://localhost"
1041
- )
1042
-
1043
-
1044
- # Enter a context with an instance of the API client
1045
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1046
- # Create an instance of the API class
1047
- api_instance = hindsight_client_api.DefaultApi(api_client)
1048
- bank_id = 'bank_id_example' # str |
1049
- type = 'type_example' # str | (optional)
1050
- q = 'q_example' # str | (optional)
1051
- limit = 100 # int | (optional) (default to 100)
1052
- offset = 0 # int | (optional) (default to 0)
1053
-
1054
- try:
1055
- # List memory units
1056
- api_response = await api_instance.list_memories(bank_id, type=type, q=q, limit=limit, offset=offset)
1057
- print("The response of DefaultApi->list_memories:\n")
1058
- pprint(api_response)
1059
- except Exception as e:
1060
- print("Exception when calling DefaultApi->list_memories: %s\n" % e)
1061
- ```
1062
-
1063
-
1064
-
1065
- ### Parameters
1066
-
1067
-
1068
- Name | Type | Description | Notes
1069
- ------------- | ------------- | ------------- | -------------
1070
- **bank_id** | **str**| |
1071
- **type** | **str**| | [optional]
1072
- **q** | **str**| | [optional]
1073
- **limit** | **int**| | [optional] [default to 100]
1074
- **offset** | **int**| | [optional] [default to 0]
1075
-
1076
- ### Return type
1077
-
1078
- [**ListMemoryUnitsResponse**](ListMemoryUnitsResponse.md)
1079
-
1080
- ### Authorization
1081
-
1082
- No authorization required
1083
-
1084
- ### HTTP request headers
1085
-
1086
- - **Content-Type**: Not defined
1087
- - **Accept**: application/json
1088
-
1089
- ### HTTP response details
1090
-
1091
- | Status code | Description | Response headers |
1092
- |-------------|-------------|------------------|
1093
- **200** | Successful Response | - |
1094
- **422** | Validation Error | - |
1095
-
1096
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1097
-
1098
- # **list_operations**
1099
- > object list_operations(bank_id)
1100
-
1101
- List async operations
1102
-
1103
- Get a list of all async operations (pending and failed) for a specific agent, including error messages for failed operations
1104
-
1105
- ### Example
1106
-
1107
-
1108
- ```python
1109
- import hindsight_client_api
1110
- from hindsight_client_api.rest import ApiException
1111
- from pprint import pprint
1112
-
1113
- # Defining the host is optional and defaults to http://localhost
1114
- # See configuration.py for a list of all supported configuration parameters.
1115
- configuration = hindsight_client_api.Configuration(
1116
- host = "http://localhost"
1117
- )
1118
-
1119
-
1120
- # Enter a context with an instance of the API client
1121
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1122
- # Create an instance of the API class
1123
- api_instance = hindsight_client_api.DefaultApi(api_client)
1124
- bank_id = 'bank_id_example' # str |
1125
-
1126
- try:
1127
- # List async operations
1128
- api_response = await api_instance.list_operations(bank_id)
1129
- print("The response of DefaultApi->list_operations:\n")
1130
- pprint(api_response)
1131
- except Exception as e:
1132
- print("Exception when calling DefaultApi->list_operations: %s\n" % e)
1133
- ```
1134
-
1135
-
1136
-
1137
- ### Parameters
1138
-
1139
-
1140
- Name | Type | Description | Notes
1141
- ------------- | ------------- | ------------- | -------------
1142
- **bank_id** | **str**| |
1143
-
1144
- ### Return type
1145
-
1146
- **object**
1147
-
1148
- ### Authorization
1149
-
1150
- No authorization required
1151
-
1152
- ### HTTP request headers
1153
-
1154
- - **Content-Type**: Not defined
1155
- - **Accept**: application/json
1156
-
1157
- ### HTTP response details
1158
-
1159
- | Status code | Description | Response headers |
1160
- |-------------|-------------|------------------|
1161
- **200** | Successful Response | - |
1162
- **422** | Validation Error | - |
1163
-
1164
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1165
-
1166
- # **recall_memories**
1167
- > RecallResponse recall_memories(bank_id, recall_request)
1168
-
1169
- Recall memory
1170
-
1171
- Recall memory using semantic similarity and spreading activation.
1172
-
1173
- The type parameter is optional and must be one of:
1174
- - 'world': General knowledge about people, places, events, and things that happen
1175
- - 'experience': Memories about experience, conversations, actions taken, and tasks performed
1176
- - 'opinion': The bank's formed beliefs, perspectives, and viewpoints
1177
-
1178
- Set include_entities=true to get entity observations alongside recall results.
1179
-
1180
- ### Example
1181
-
1182
-
1183
- ```python
1184
- import hindsight_client_api
1185
- from hindsight_client_api.models.recall_request import RecallRequest
1186
- from hindsight_client_api.models.recall_response import RecallResponse
1187
- from hindsight_client_api.rest import ApiException
1188
- from pprint import pprint
1189
-
1190
- # Defining the host is optional and defaults to http://localhost
1191
- # See configuration.py for a list of all supported configuration parameters.
1192
- configuration = hindsight_client_api.Configuration(
1193
- host = "http://localhost"
1194
- )
1195
-
1196
-
1197
- # Enter a context with an instance of the API client
1198
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1199
- # Create an instance of the API class
1200
- api_instance = hindsight_client_api.DefaultApi(api_client)
1201
- bank_id = 'bank_id_example' # str |
1202
- recall_request = hindsight_client_api.RecallRequest() # RecallRequest |
1203
-
1204
- try:
1205
- # Recall memory
1206
- api_response = await api_instance.recall_memories(bank_id, recall_request)
1207
- print("The response of DefaultApi->recall_memories:\n")
1208
- pprint(api_response)
1209
- except Exception as e:
1210
- print("Exception when calling DefaultApi->recall_memories: %s\n" % e)
1211
- ```
1212
-
1213
-
1214
-
1215
- ### Parameters
1216
-
1217
-
1218
- Name | Type | Description | Notes
1219
- ------------- | ------------- | ------------- | -------------
1220
- **bank_id** | **str**| |
1221
- **recall_request** | [**RecallRequest**](RecallRequest.md)| |
1222
-
1223
- ### Return type
1224
-
1225
- [**RecallResponse**](RecallResponse.md)
1226
-
1227
- ### Authorization
1228
-
1229
- No authorization required
1230
-
1231
- ### HTTP request headers
1232
-
1233
- - **Content-Type**: application/json
1234
- - **Accept**: application/json
1235
-
1236
- ### HTTP response details
1237
-
1238
- | Status code | Description | Response headers |
1239
- |-------------|-------------|------------------|
1240
- **200** | Successful Response | - |
1241
- **422** | Validation Error | - |
1242
-
1243
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1244
-
1245
- # **reflect**
1246
- > ReflectResponse reflect(bank_id, reflect_request)
1247
-
1248
- Reflect and generate answer
1249
-
1250
- Reflect and formulate an answer using bank identity, world facts, and opinions.
1251
-
1252
- This endpoint:
1253
- 1. Retrieves experience (conversations and events)
1254
- 2. Retrieves world facts relevant to the query
1255
- 3. Retrieves existing opinions (bank's perspectives)
1256
- 4. Uses LLM to formulate a contextual answer
1257
- 5. Extracts and stores any new opinions formed
1258
- 6. Returns plain text answer, the facts used, and new opinions
1259
-
1260
- ### Example
1261
-
1262
-
1263
- ```python
1264
- import hindsight_client_api
1265
- from hindsight_client_api.models.reflect_request import ReflectRequest
1266
- from hindsight_client_api.models.reflect_response import ReflectResponse
1267
- from hindsight_client_api.rest import ApiException
1268
- from pprint import pprint
1269
-
1270
- # Defining the host is optional and defaults to http://localhost
1271
- # See configuration.py for a list of all supported configuration parameters.
1272
- configuration = hindsight_client_api.Configuration(
1273
- host = "http://localhost"
1274
- )
1275
-
1276
-
1277
- # Enter a context with an instance of the API client
1278
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1279
- # Create an instance of the API class
1280
- api_instance = hindsight_client_api.DefaultApi(api_client)
1281
- bank_id = 'bank_id_example' # str |
1282
- reflect_request = hindsight_client_api.ReflectRequest() # ReflectRequest |
1283
-
1284
- try:
1285
- # Reflect and generate answer
1286
- api_response = await api_instance.reflect(bank_id, reflect_request)
1287
- print("The response of DefaultApi->reflect:\n")
1288
- pprint(api_response)
1289
- except Exception as e:
1290
- print("Exception when calling DefaultApi->reflect: %s\n" % e)
1291
- ```
1292
-
1293
-
1294
-
1295
- ### Parameters
1296
-
1297
-
1298
- Name | Type | Description | Notes
1299
- ------------- | ------------- | ------------- | -------------
1300
- **bank_id** | **str**| |
1301
- **reflect_request** | [**ReflectRequest**](ReflectRequest.md)| |
1302
-
1303
- ### Return type
1304
-
1305
- [**ReflectResponse**](ReflectResponse.md)
1306
-
1307
- ### Authorization
1308
-
1309
- No authorization required
1310
-
1311
- ### HTTP request headers
1312
-
1313
- - **Content-Type**: application/json
1314
- - **Accept**: application/json
1315
-
1316
- ### HTTP response details
1317
-
1318
- | Status code | Description | Response headers |
1319
- |-------------|-------------|------------------|
1320
- **200** | Successful Response | - |
1321
- **422** | Validation Error | - |
1322
-
1323
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1324
-
1325
- # **regenerate_entity_observations**
1326
- > EntityDetailResponse regenerate_entity_observations(bank_id, entity_id)
1327
-
1328
- Regenerate entity observations
1329
-
1330
- Regenerate observations for an entity based on all facts mentioning it.
1331
-
1332
- ### Example
1333
-
1334
-
1335
- ```python
1336
- import hindsight_client_api
1337
- from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
1338
- from hindsight_client_api.rest import ApiException
1339
- from pprint import pprint
1340
-
1341
- # Defining the host is optional and defaults to http://localhost
1342
- # See configuration.py for a list of all supported configuration parameters.
1343
- configuration = hindsight_client_api.Configuration(
1344
- host = "http://localhost"
1345
- )
1346
-
1347
-
1348
- # Enter a context with an instance of the API client
1349
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1350
- # Create an instance of the API class
1351
- api_instance = hindsight_client_api.DefaultApi(api_client)
1352
- bank_id = 'bank_id_example' # str |
1353
- entity_id = 'entity_id_example' # str |
1354
-
1355
- try:
1356
- # Regenerate entity observations
1357
- api_response = await api_instance.regenerate_entity_observations(bank_id, entity_id)
1358
- print("The response of DefaultApi->regenerate_entity_observations:\n")
1359
- pprint(api_response)
1360
- except Exception as e:
1361
- print("Exception when calling DefaultApi->regenerate_entity_observations: %s\n" % e)
1362
- ```
1363
-
1364
-
1365
-
1366
- ### Parameters
1367
-
1368
-
1369
- Name | Type | Description | Notes
1370
- ------------- | ------------- | ------------- | -------------
1371
- **bank_id** | **str**| |
1372
- **entity_id** | **str**| |
1373
-
1374
- ### Return type
1375
-
1376
- [**EntityDetailResponse**](EntityDetailResponse.md)
1377
-
1378
- ### Authorization
1379
-
1380
- No authorization required
1381
-
1382
- ### HTTP request headers
1383
-
1384
- - **Content-Type**: Not defined
1385
- - **Accept**: application/json
1386
-
1387
- ### HTTP response details
1388
-
1389
- | Status code | Description | Response headers |
1390
- |-------------|-------------|------------------|
1391
- **200** | Successful Response | - |
1392
- **422** | Validation Error | - |
1393
-
1394
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1395
-
1396
- # **retain_memories**
1397
- > RetainResponse retain_memories(bank_id, retain_request)
1398
-
1399
- Retain memories
1400
-
1401
- Retain memory items with automatic fact extraction.
1402
-
1403
- This is the main endpoint for storing memories. It supports both synchronous and asynchronous processing
1404
- via the async parameter.
1405
-
1406
- Features:
1407
- - Efficient batch processing
1408
- - Automatic fact extraction from natural language
1409
- - Entity recognition and linking
1410
- - Document tracking with automatic upsert (when document_id is provided on items)
1411
- - Temporal and semantic linking
1412
- - Optional asynchronous processing
1413
-
1414
- The system automatically:
1415
- 1. Extracts semantic facts from the content
1416
- 2. Generates embeddings
1417
- 3. Deduplicates similar facts
1418
- 4. Creates temporal, semantic, and entity links
1419
- 5. Tracks document metadata
1420
-
1421
- When async=true:
1422
- - Returns immediately after queuing the task
1423
- - Processing happens in the background
1424
- - Use the operations endpoint to monitor progress
1425
-
1426
- When async=false (default):
1427
- - Waits for processing to complete
1428
- - Returns after all memories are stored
1429
-
1430
- Note: If a memory item has a document_id that already exists, the old document and its memory units will be deleted before creating new ones (upsert behavior). Items with the same document_id are grouped together for efficient processing.
1431
-
1432
- ### Example
1433
-
1434
-
1435
- ```python
1436
- import hindsight_client_api
1437
- from hindsight_client_api.models.retain_request import RetainRequest
1438
- from hindsight_client_api.models.retain_response import RetainResponse
1439
- from hindsight_client_api.rest import ApiException
1440
- from pprint import pprint
1441
-
1442
- # Defining the host is optional and defaults to http://localhost
1443
- # See configuration.py for a list of all supported configuration parameters.
1444
- configuration = hindsight_client_api.Configuration(
1445
- host = "http://localhost"
1446
- )
1447
-
1448
-
1449
- # Enter a context with an instance of the API client
1450
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1451
- # Create an instance of the API class
1452
- api_instance = hindsight_client_api.DefaultApi(api_client)
1453
- bank_id = 'bank_id_example' # str |
1454
- retain_request = hindsight_client_api.RetainRequest() # RetainRequest |
1455
-
1456
- try:
1457
- # Retain memories
1458
- api_response = await api_instance.retain_memories(bank_id, retain_request)
1459
- print("The response of DefaultApi->retain_memories:\n")
1460
- pprint(api_response)
1461
- except Exception as e:
1462
- print("Exception when calling DefaultApi->retain_memories: %s\n" % e)
1463
- ```
1464
-
1465
-
1466
-
1467
- ### Parameters
1468
-
1469
-
1470
- Name | Type | Description | Notes
1471
- ------------- | ------------- | ------------- | -------------
1472
- **bank_id** | **str**| |
1473
- **retain_request** | [**RetainRequest**](RetainRequest.md)| |
1474
-
1475
- ### Return type
1476
-
1477
- [**RetainResponse**](RetainResponse.md)
1478
-
1479
- ### Authorization
1480
-
1481
- No authorization required
1482
-
1483
- ### HTTP request headers
1484
-
1485
- - **Content-Type**: application/json
1486
- - **Accept**: application/json
1487
-
1488
- ### HTTP response details
1489
-
1490
- | Status code | Description | Response headers |
1491
- |-------------|-------------|------------------|
1492
- **200** | Successful Response | - |
1493
- **422** | Validation Error | - |
1494
-
1495
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1496
-
1497
- # **update_bank_disposition**
1498
- > BankProfileResponse update_bank_disposition(bank_id, update_disposition_request)
1499
-
1500
- Update memory bank disposition
1501
-
1502
- Update bank's disposition traits (skepticism, literalism, empathy)
1503
-
1504
- ### Example
1505
-
1506
-
1507
- ```python
1508
- import hindsight_client_api
1509
- from hindsight_client_api.models.bank_profile_response import BankProfileResponse
1510
- from hindsight_client_api.models.update_disposition_request import UpdateDispositionRequest
1511
- from hindsight_client_api.rest import ApiException
1512
- from pprint import pprint
1513
-
1514
- # Defining the host is optional and defaults to http://localhost
1515
- # See configuration.py for a list of all supported configuration parameters.
1516
- configuration = hindsight_client_api.Configuration(
1517
- host = "http://localhost"
1518
- )
1519
-
1520
-
1521
- # Enter a context with an instance of the API client
1522
- async with hindsight_client_api.ApiClient(configuration) as api_client:
1523
- # Create an instance of the API class
1524
- api_instance = hindsight_client_api.DefaultApi(api_client)
1525
- bank_id = 'bank_id_example' # str |
1526
- update_disposition_request = hindsight_client_api.UpdateDispositionRequest() # UpdateDispositionRequest |
1527
-
1528
- try:
1529
- # Update memory bank disposition
1530
- api_response = await api_instance.update_bank_disposition(bank_id, update_disposition_request)
1531
- print("The response of DefaultApi->update_bank_disposition:\n")
1532
- pprint(api_response)
1533
- except Exception as e:
1534
- print("Exception when calling DefaultApi->update_bank_disposition: %s\n" % e)
1535
- ```
1536
-
1537
-
1538
-
1539
- ### Parameters
1540
-
1541
-
1542
- Name | Type | Description | Notes
1543
- ------------- | ------------- | ------------- | -------------
1544
- **bank_id** | **str**| |
1545
- **update_disposition_request** | [**UpdateDispositionRequest**](UpdateDispositionRequest.md)| |
1546
-
1547
- ### Return type
1548
-
1549
- [**BankProfileResponse**](BankProfileResponse.md)
1550
-
1551
- ### Authorization
1552
-
1553
- No authorization required
1554
-
1555
- ### HTTP request headers
1556
-
1557
- - **Content-Type**: application/json
1558
- - **Accept**: application/json
1559
-
1560
- ### HTTP response details
1561
-
1562
- | Status code | Description | Response headers |
1563
- |-------------|-------------|------------------|
1564
- **200** | Successful Response | - |
1565
- **422** | Validation Error | - |
1566
-
1567
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1568
-