hindsight-client 0.0.13__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.
- hindsight_client/__init__.py +26 -0
- hindsight_client/hindsight_client.py +432 -0
- hindsight_client-0.0.13.dist-info/METADATA +56 -0
- hindsight_client-0.0.13.dist-info/RECORD +134 -0
- hindsight_client-0.0.13.dist-info/WHEEL +4 -0
- hindsight_client_api/__init__.py +126 -0
- hindsight_client_api/api/__init__.py +6 -0
- hindsight_client_api/api/default_api.py +5976 -0
- hindsight_client_api/api/monitoring_api.py +281 -0
- hindsight_client_api/api_client.py +807 -0
- hindsight_client_api/api_response.py +21 -0
- hindsight_client_api/configuration.py +572 -0
- hindsight_client_api/docs/AddBackgroundRequest.md +31 -0
- hindsight_client_api/docs/BackgroundResponse.md +31 -0
- hindsight_client_api/docs/BankListItem.md +35 -0
- hindsight_client_api/docs/BankListResponse.md +30 -0
- hindsight_client_api/docs/BankProfileResponse.md +33 -0
- hindsight_client_api/docs/Budget.md +15 -0
- hindsight_client_api/docs/ChunkData.md +33 -0
- hindsight_client_api/docs/ChunkIncludeOptions.md +30 -0
- hindsight_client_api/docs/ChunkResponse.md +35 -0
- hindsight_client_api/docs/CreateBankRequest.md +32 -0
- hindsight_client_api/docs/DefaultApi.md +1569 -0
- hindsight_client_api/docs/DeleteResponse.md +30 -0
- hindsight_client_api/docs/DocumentResponse.md +36 -0
- hindsight_client_api/docs/EntityDetailResponse.md +36 -0
- hindsight_client_api/docs/EntityIncludeOptions.md +30 -0
- hindsight_client_api/docs/EntityListItem.md +35 -0
- hindsight_client_api/docs/EntityListResponse.md +30 -0
- hindsight_client_api/docs/EntityObservationResponse.md +31 -0
- hindsight_client_api/docs/EntityStateResponse.md +32 -0
- hindsight_client_api/docs/GraphDataResponse.md +33 -0
- hindsight_client_api/docs/HTTPValidationError.md +29 -0
- hindsight_client_api/docs/IncludeOptions.md +31 -0
- hindsight_client_api/docs/ListDocumentsResponse.md +33 -0
- hindsight_client_api/docs/ListMemoryUnitsResponse.md +33 -0
- hindsight_client_api/docs/MemoryItem.md +34 -0
- hindsight_client_api/docs/MetadataFilter.md +32 -0
- hindsight_client_api/docs/MonitoringApi.md +72 -0
- hindsight_client_api/docs/PersonalityTraits.md +35 -0
- hindsight_client_api/docs/RecallRequest.md +37 -0
- hindsight_client_api/docs/RecallResponse.md +33 -0
- hindsight_client_api/docs/RecallResult.md +40 -0
- hindsight_client_api/docs/ReflectFact.md +35 -0
- hindsight_client_api/docs/ReflectIncludeOptions.md +30 -0
- hindsight_client_api/docs/ReflectRequest.md +34 -0
- hindsight_client_api/docs/ReflectResponse.md +31 -0
- hindsight_client_api/docs/RetainRequest.md +31 -0
- hindsight_client_api/docs/RetainResponse.md +33 -0
- hindsight_client_api/docs/UpdatePersonalityRequest.md +30 -0
- hindsight_client_api/docs/ValidationError.md +31 -0
- hindsight_client_api/docs/ValidationErrorLocInner.md +28 -0
- hindsight_client_api/exceptions.py +219 -0
- hindsight_client_api/models/__init__.py +54 -0
- hindsight_client_api/models/add_background_request.py +89 -0
- hindsight_client_api/models/background_response.py +98 -0
- hindsight_client_api/models/bank_list_item.py +111 -0
- hindsight_client_api/models/bank_list_response.py +95 -0
- hindsight_client_api/models/bank_profile_response.py +97 -0
- hindsight_client_api/models/budget.py +38 -0
- hindsight_client_api/models/chunk_data.py +93 -0
- hindsight_client_api/models/chunk_include_options.py +87 -0
- hindsight_client_api/models/chunk_response.py +97 -0
- hindsight_client_api/models/create_bank_request.py +110 -0
- hindsight_client_api/models/delete_response.py +87 -0
- hindsight_client_api/models/document_response.py +104 -0
- hindsight_client_api/models/entity_detail_response.py +122 -0
- hindsight_client_api/models/entity_include_options.py +87 -0
- hindsight_client_api/models/entity_list_item.py +112 -0
- hindsight_client_api/models/entity_list_response.py +95 -0
- hindsight_client_api/models/entity_observation_response.py +94 -0
- hindsight_client_api/models/entity_state_response.py +99 -0
- hindsight_client_api/models/graph_data_response.py +93 -0
- hindsight_client_api/models/http_validation_error.py +95 -0
- hindsight_client_api/models/include_options.py +107 -0
- hindsight_client_api/models/list_documents_response.py +93 -0
- hindsight_client_api/models/list_memory_units_response.py +93 -0
- hindsight_client_api/models/memory_item.py +116 -0
- hindsight_client_api/models/metadata_filter.py +96 -0
- hindsight_client_api/models/personality_traits.py +98 -0
- hindsight_client_api/models/recall_request.py +129 -0
- hindsight_client_api/models/recall_response.py +142 -0
- hindsight_client_api/models/recall_result.py +152 -0
- hindsight_client_api/models/reflect_fact.py +122 -0
- hindsight_client_api/models/reflect_include_options.py +87 -0
- hindsight_client_api/models/reflect_request.py +118 -0
- hindsight_client_api/models/reflect_response.py +97 -0
- hindsight_client_api/models/retain_request.py +97 -0
- hindsight_client_api/models/retain_response.py +93 -0
- hindsight_client_api/models/update_personality_request.py +91 -0
- hindsight_client_api/models/validation_error.py +99 -0
- hindsight_client_api/models/validation_error_loc_inner.py +138 -0
- hindsight_client_api/rest.py +213 -0
- hindsight_client_api/test/__init__.py +0 -0
- hindsight_client_api/test/test_add_background_request.py +53 -0
- hindsight_client_api/test/test_background_response.py +53 -0
- hindsight_client_api/test/test_bank_list_item.py +60 -0
- hindsight_client_api/test/test_bank_list_response.py +68 -0
- hindsight_client_api/test/test_bank_profile_response.py +58 -0
- hindsight_client_api/test/test_budget.py +33 -0
- hindsight_client_api/test/test_chunk_data.py +57 -0
- hindsight_client_api/test/test_chunk_include_options.py +51 -0
- hindsight_client_api/test/test_chunk_response.py +62 -0
- hindsight_client_api/test/test_create_bank_request.py +53 -0
- hindsight_client_api/test/test_default_api.py +178 -0
- hindsight_client_api/test/test_delete_response.py +52 -0
- hindsight_client_api/test/test_document_response.py +64 -0
- hindsight_client_api/test/test_entity_detail_response.py +71 -0
- hindsight_client_api/test/test_entity_include_options.py +51 -0
- hindsight_client_api/test/test_entity_list_item.py +61 -0
- hindsight_client_api/test/test_entity_list_response.py +56 -0
- hindsight_client_api/test/test_entity_observation_response.py +53 -0
- hindsight_client_api/test/test_entity_state_response.py +64 -0
- hindsight_client_api/test/test_graph_data_response.py +82 -0
- hindsight_client_api/test/test_http_validation_error.py +58 -0
- hindsight_client_api/test/test_include_options.py +54 -0
- hindsight_client_api/test/test_list_documents_response.py +66 -0
- hindsight_client_api/test/test_list_memory_units_response.py +66 -0
- hindsight_client_api/test/test_memory_item.py +58 -0
- hindsight_client_api/test/test_metadata_filter.py +54 -0
- hindsight_client_api/test/test_monitoring_api.py +38 -0
- hindsight_client_api/test/test_personality_traits.py +62 -0
- hindsight_client_api/test/test_recall_request.py +67 -0
- hindsight_client_api/test/test_recall_response.py +76 -0
- hindsight_client_api/test/test_recall_result.py +67 -0
- hindsight_client_api/test/test_reflect_fact.py +57 -0
- hindsight_client_api/test/test_reflect_include_options.py +51 -0
- hindsight_client_api/test/test_reflect_request.py +59 -0
- hindsight_client_api/test/test_reflect_response.py +55 -0
- hindsight_client_api/test/test_retain_request.py +57 -0
- hindsight_client_api/test/test_retain_response.py +58 -0
- hindsight_client_api/test/test_update_personality_request.py +52 -0
- hindsight_client_api/test/test_validation_error.py +60 -0
- hindsight_client_api/test/test_validation_error_loc_inner.py +50 -0
|
@@ -0,0 +1,1569 @@
|
|
|
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_personality**](DefaultApi.md#update_bank_personality) | **PUT** /v1/default/banks/{bank_id}/profile | Update memory bank personality
|
|
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 personality 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, agent, opinion) to delete only specific types. This is a destructive operation that cannot be undone. The bank profile (personality 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, agent, 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, agent, 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 personality 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 personality 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/agent/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
|
+
- 'agent': Memories about what the AI agent did, actions taken, and tasks performed
|
|
1176
|
+
- 'opinion': The bank's formed beliefs, perspectives, and viewpoints
|
|
1177
|
+
- 'observation': Synthesized observations about entities (generated automatically)
|
|
1178
|
+
|
|
1179
|
+
Set include_entities=true to get entity observations alongside recall results.
|
|
1180
|
+
|
|
1181
|
+
### Example
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
```python
|
|
1185
|
+
import hindsight_client_api
|
|
1186
|
+
from hindsight_client_api.models.recall_request import RecallRequest
|
|
1187
|
+
from hindsight_client_api.models.recall_response import RecallResponse
|
|
1188
|
+
from hindsight_client_api.rest import ApiException
|
|
1189
|
+
from pprint import pprint
|
|
1190
|
+
|
|
1191
|
+
# Defining the host is optional and defaults to http://localhost
|
|
1192
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1193
|
+
configuration = hindsight_client_api.Configuration(
|
|
1194
|
+
host = "http://localhost"
|
|
1195
|
+
)
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
# Enter a context with an instance of the API client
|
|
1199
|
+
async with hindsight_client_api.ApiClient(configuration) as api_client:
|
|
1200
|
+
# Create an instance of the API class
|
|
1201
|
+
api_instance = hindsight_client_api.DefaultApi(api_client)
|
|
1202
|
+
bank_id = 'bank_id_example' # str |
|
|
1203
|
+
recall_request = hindsight_client_api.RecallRequest() # RecallRequest |
|
|
1204
|
+
|
|
1205
|
+
try:
|
|
1206
|
+
# Recall memory
|
|
1207
|
+
api_response = await api_instance.recall_memories(bank_id, recall_request)
|
|
1208
|
+
print("The response of DefaultApi->recall_memories:\n")
|
|
1209
|
+
pprint(api_response)
|
|
1210
|
+
except Exception as e:
|
|
1211
|
+
print("Exception when calling DefaultApi->recall_memories: %s\n" % e)
|
|
1212
|
+
```
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
### Parameters
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
Name | Type | Description | Notes
|
|
1220
|
+
------------- | ------------- | ------------- | -------------
|
|
1221
|
+
**bank_id** | **str**| |
|
|
1222
|
+
**recall_request** | [**RecallRequest**](RecallRequest.md)| |
|
|
1223
|
+
|
|
1224
|
+
### Return type
|
|
1225
|
+
|
|
1226
|
+
[**RecallResponse**](RecallResponse.md)
|
|
1227
|
+
|
|
1228
|
+
### Authorization
|
|
1229
|
+
|
|
1230
|
+
No authorization required
|
|
1231
|
+
|
|
1232
|
+
### HTTP request headers
|
|
1233
|
+
|
|
1234
|
+
- **Content-Type**: application/json
|
|
1235
|
+
- **Accept**: application/json
|
|
1236
|
+
|
|
1237
|
+
### HTTP response details
|
|
1238
|
+
|
|
1239
|
+
| Status code | Description | Response headers |
|
|
1240
|
+
|-------------|-------------|------------------|
|
|
1241
|
+
**200** | Successful Response | - |
|
|
1242
|
+
**422** | Validation Error | - |
|
|
1243
|
+
|
|
1244
|
+
[[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)
|
|
1245
|
+
|
|
1246
|
+
# **reflect**
|
|
1247
|
+
> ReflectResponse reflect(bank_id, reflect_request)
|
|
1248
|
+
|
|
1249
|
+
Reflect and generate answer
|
|
1250
|
+
|
|
1251
|
+
Reflect and formulate an answer using bank identity, world facts, and opinions.
|
|
1252
|
+
|
|
1253
|
+
This endpoint:
|
|
1254
|
+
1. Retrieves agent facts (bank's identity)
|
|
1255
|
+
2. Retrieves world facts relevant to the query
|
|
1256
|
+
3. Retrieves existing opinions (bank's perspectives)
|
|
1257
|
+
4. Uses LLM to formulate a contextual answer
|
|
1258
|
+
5. Extracts and stores any new opinions formed
|
|
1259
|
+
6. Returns plain text answer, the facts used, and new opinions
|
|
1260
|
+
|
|
1261
|
+
### Example
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
```python
|
|
1265
|
+
import hindsight_client_api
|
|
1266
|
+
from hindsight_client_api.models.reflect_request import ReflectRequest
|
|
1267
|
+
from hindsight_client_api.models.reflect_response import ReflectResponse
|
|
1268
|
+
from hindsight_client_api.rest import ApiException
|
|
1269
|
+
from pprint import pprint
|
|
1270
|
+
|
|
1271
|
+
# Defining the host is optional and defaults to http://localhost
|
|
1272
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1273
|
+
configuration = hindsight_client_api.Configuration(
|
|
1274
|
+
host = "http://localhost"
|
|
1275
|
+
)
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
# Enter a context with an instance of the API client
|
|
1279
|
+
async with hindsight_client_api.ApiClient(configuration) as api_client:
|
|
1280
|
+
# Create an instance of the API class
|
|
1281
|
+
api_instance = hindsight_client_api.DefaultApi(api_client)
|
|
1282
|
+
bank_id = 'bank_id_example' # str |
|
|
1283
|
+
reflect_request = hindsight_client_api.ReflectRequest() # ReflectRequest |
|
|
1284
|
+
|
|
1285
|
+
try:
|
|
1286
|
+
# Reflect and generate answer
|
|
1287
|
+
api_response = await api_instance.reflect(bank_id, reflect_request)
|
|
1288
|
+
print("The response of DefaultApi->reflect:\n")
|
|
1289
|
+
pprint(api_response)
|
|
1290
|
+
except Exception as e:
|
|
1291
|
+
print("Exception when calling DefaultApi->reflect: %s\n" % e)
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
### Parameters
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
Name | Type | Description | Notes
|
|
1300
|
+
------------- | ------------- | ------------- | -------------
|
|
1301
|
+
**bank_id** | **str**| |
|
|
1302
|
+
**reflect_request** | [**ReflectRequest**](ReflectRequest.md)| |
|
|
1303
|
+
|
|
1304
|
+
### Return type
|
|
1305
|
+
|
|
1306
|
+
[**ReflectResponse**](ReflectResponse.md)
|
|
1307
|
+
|
|
1308
|
+
### Authorization
|
|
1309
|
+
|
|
1310
|
+
No authorization required
|
|
1311
|
+
|
|
1312
|
+
### HTTP request headers
|
|
1313
|
+
|
|
1314
|
+
- **Content-Type**: application/json
|
|
1315
|
+
- **Accept**: application/json
|
|
1316
|
+
|
|
1317
|
+
### HTTP response details
|
|
1318
|
+
|
|
1319
|
+
| Status code | Description | Response headers |
|
|
1320
|
+
|-------------|-------------|------------------|
|
|
1321
|
+
**200** | Successful Response | - |
|
|
1322
|
+
**422** | Validation Error | - |
|
|
1323
|
+
|
|
1324
|
+
[[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)
|
|
1325
|
+
|
|
1326
|
+
# **regenerate_entity_observations**
|
|
1327
|
+
> EntityDetailResponse regenerate_entity_observations(bank_id, entity_id)
|
|
1328
|
+
|
|
1329
|
+
Regenerate entity observations
|
|
1330
|
+
|
|
1331
|
+
Regenerate observations for an entity based on all facts mentioning it.
|
|
1332
|
+
|
|
1333
|
+
### Example
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
```python
|
|
1337
|
+
import hindsight_client_api
|
|
1338
|
+
from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
|
|
1339
|
+
from hindsight_client_api.rest import ApiException
|
|
1340
|
+
from pprint import pprint
|
|
1341
|
+
|
|
1342
|
+
# Defining the host is optional and defaults to http://localhost
|
|
1343
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1344
|
+
configuration = hindsight_client_api.Configuration(
|
|
1345
|
+
host = "http://localhost"
|
|
1346
|
+
)
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
# Enter a context with an instance of the API client
|
|
1350
|
+
async with hindsight_client_api.ApiClient(configuration) as api_client:
|
|
1351
|
+
# Create an instance of the API class
|
|
1352
|
+
api_instance = hindsight_client_api.DefaultApi(api_client)
|
|
1353
|
+
bank_id = 'bank_id_example' # str |
|
|
1354
|
+
entity_id = 'entity_id_example' # str |
|
|
1355
|
+
|
|
1356
|
+
try:
|
|
1357
|
+
# Regenerate entity observations
|
|
1358
|
+
api_response = await api_instance.regenerate_entity_observations(bank_id, entity_id)
|
|
1359
|
+
print("The response of DefaultApi->regenerate_entity_observations:\n")
|
|
1360
|
+
pprint(api_response)
|
|
1361
|
+
except Exception as e:
|
|
1362
|
+
print("Exception when calling DefaultApi->regenerate_entity_observations: %s\n" % e)
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
### Parameters
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
Name | Type | Description | Notes
|
|
1371
|
+
------------- | ------------- | ------------- | -------------
|
|
1372
|
+
**bank_id** | **str**| |
|
|
1373
|
+
**entity_id** | **str**| |
|
|
1374
|
+
|
|
1375
|
+
### Return type
|
|
1376
|
+
|
|
1377
|
+
[**EntityDetailResponse**](EntityDetailResponse.md)
|
|
1378
|
+
|
|
1379
|
+
### Authorization
|
|
1380
|
+
|
|
1381
|
+
No authorization required
|
|
1382
|
+
|
|
1383
|
+
### HTTP request headers
|
|
1384
|
+
|
|
1385
|
+
- **Content-Type**: Not defined
|
|
1386
|
+
- **Accept**: application/json
|
|
1387
|
+
|
|
1388
|
+
### HTTP response details
|
|
1389
|
+
|
|
1390
|
+
| Status code | Description | Response headers |
|
|
1391
|
+
|-------------|-------------|------------------|
|
|
1392
|
+
**200** | Successful Response | - |
|
|
1393
|
+
**422** | Validation Error | - |
|
|
1394
|
+
|
|
1395
|
+
[[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)
|
|
1396
|
+
|
|
1397
|
+
# **retain_memories**
|
|
1398
|
+
> RetainResponse retain_memories(bank_id, retain_request)
|
|
1399
|
+
|
|
1400
|
+
Retain memories
|
|
1401
|
+
|
|
1402
|
+
Retain memory items with automatic fact extraction.
|
|
1403
|
+
|
|
1404
|
+
This is the main endpoint for storing memories. It supports both synchronous and asynchronous processing
|
|
1405
|
+
via the async parameter.
|
|
1406
|
+
|
|
1407
|
+
Features:
|
|
1408
|
+
- Efficient batch processing
|
|
1409
|
+
- Automatic fact extraction from natural language
|
|
1410
|
+
- Entity recognition and linking
|
|
1411
|
+
- Document tracking with automatic upsert (when document_id is provided on items)
|
|
1412
|
+
- Temporal and semantic linking
|
|
1413
|
+
- Optional asynchronous processing
|
|
1414
|
+
|
|
1415
|
+
The system automatically:
|
|
1416
|
+
1. Extracts semantic facts from the content
|
|
1417
|
+
2. Generates embeddings
|
|
1418
|
+
3. Deduplicates similar facts
|
|
1419
|
+
4. Creates temporal, semantic, and entity links
|
|
1420
|
+
5. Tracks document metadata
|
|
1421
|
+
|
|
1422
|
+
When async=true:
|
|
1423
|
+
- Returns immediately after queuing the task
|
|
1424
|
+
- Processing happens in the background
|
|
1425
|
+
- Use the operations endpoint to monitor progress
|
|
1426
|
+
|
|
1427
|
+
When async=false (default):
|
|
1428
|
+
- Waits for processing to complete
|
|
1429
|
+
- Returns after all memories are stored
|
|
1430
|
+
|
|
1431
|
+
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.
|
|
1432
|
+
|
|
1433
|
+
### Example
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
```python
|
|
1437
|
+
import hindsight_client_api
|
|
1438
|
+
from hindsight_client_api.models.retain_request import RetainRequest
|
|
1439
|
+
from hindsight_client_api.models.retain_response import RetainResponse
|
|
1440
|
+
from hindsight_client_api.rest import ApiException
|
|
1441
|
+
from pprint import pprint
|
|
1442
|
+
|
|
1443
|
+
# Defining the host is optional and defaults to http://localhost
|
|
1444
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1445
|
+
configuration = hindsight_client_api.Configuration(
|
|
1446
|
+
host = "http://localhost"
|
|
1447
|
+
)
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
# Enter a context with an instance of the API client
|
|
1451
|
+
async with hindsight_client_api.ApiClient(configuration) as api_client:
|
|
1452
|
+
# Create an instance of the API class
|
|
1453
|
+
api_instance = hindsight_client_api.DefaultApi(api_client)
|
|
1454
|
+
bank_id = 'bank_id_example' # str |
|
|
1455
|
+
retain_request = hindsight_client_api.RetainRequest() # RetainRequest |
|
|
1456
|
+
|
|
1457
|
+
try:
|
|
1458
|
+
# Retain memories
|
|
1459
|
+
api_response = await api_instance.retain_memories(bank_id, retain_request)
|
|
1460
|
+
print("The response of DefaultApi->retain_memories:\n")
|
|
1461
|
+
pprint(api_response)
|
|
1462
|
+
except Exception as e:
|
|
1463
|
+
print("Exception when calling DefaultApi->retain_memories: %s\n" % e)
|
|
1464
|
+
```
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
### Parameters
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
Name | Type | Description | Notes
|
|
1472
|
+
------------- | ------------- | ------------- | -------------
|
|
1473
|
+
**bank_id** | **str**| |
|
|
1474
|
+
**retain_request** | [**RetainRequest**](RetainRequest.md)| |
|
|
1475
|
+
|
|
1476
|
+
### Return type
|
|
1477
|
+
|
|
1478
|
+
[**RetainResponse**](RetainResponse.md)
|
|
1479
|
+
|
|
1480
|
+
### Authorization
|
|
1481
|
+
|
|
1482
|
+
No authorization required
|
|
1483
|
+
|
|
1484
|
+
### HTTP request headers
|
|
1485
|
+
|
|
1486
|
+
- **Content-Type**: application/json
|
|
1487
|
+
- **Accept**: application/json
|
|
1488
|
+
|
|
1489
|
+
### HTTP response details
|
|
1490
|
+
|
|
1491
|
+
| Status code | Description | Response headers |
|
|
1492
|
+
|-------------|-------------|------------------|
|
|
1493
|
+
**200** | Successful Response | - |
|
|
1494
|
+
**422** | Validation Error | - |
|
|
1495
|
+
|
|
1496
|
+
[[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)
|
|
1497
|
+
|
|
1498
|
+
# **update_bank_personality**
|
|
1499
|
+
> BankProfileResponse update_bank_personality(bank_id, update_personality_request)
|
|
1500
|
+
|
|
1501
|
+
Update memory bank personality
|
|
1502
|
+
|
|
1503
|
+
Update bank's Big Five personality traits and bias strength
|
|
1504
|
+
|
|
1505
|
+
### Example
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
```python
|
|
1509
|
+
import hindsight_client_api
|
|
1510
|
+
from hindsight_client_api.models.bank_profile_response import BankProfileResponse
|
|
1511
|
+
from hindsight_client_api.models.update_personality_request import UpdatePersonalityRequest
|
|
1512
|
+
from hindsight_client_api.rest import ApiException
|
|
1513
|
+
from pprint import pprint
|
|
1514
|
+
|
|
1515
|
+
# Defining the host is optional and defaults to http://localhost
|
|
1516
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1517
|
+
configuration = hindsight_client_api.Configuration(
|
|
1518
|
+
host = "http://localhost"
|
|
1519
|
+
)
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
# Enter a context with an instance of the API client
|
|
1523
|
+
async with hindsight_client_api.ApiClient(configuration) as api_client:
|
|
1524
|
+
# Create an instance of the API class
|
|
1525
|
+
api_instance = hindsight_client_api.DefaultApi(api_client)
|
|
1526
|
+
bank_id = 'bank_id_example' # str |
|
|
1527
|
+
update_personality_request = hindsight_client_api.UpdatePersonalityRequest() # UpdatePersonalityRequest |
|
|
1528
|
+
|
|
1529
|
+
try:
|
|
1530
|
+
# Update memory bank personality
|
|
1531
|
+
api_response = await api_instance.update_bank_personality(bank_id, update_personality_request)
|
|
1532
|
+
print("The response of DefaultApi->update_bank_personality:\n")
|
|
1533
|
+
pprint(api_response)
|
|
1534
|
+
except Exception as e:
|
|
1535
|
+
print("Exception when calling DefaultApi->update_bank_personality: %s\n" % e)
|
|
1536
|
+
```
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
### Parameters
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
Name | Type | Description | Notes
|
|
1544
|
+
------------- | ------------- | ------------- | -------------
|
|
1545
|
+
**bank_id** | **str**| |
|
|
1546
|
+
**update_personality_request** | [**UpdatePersonalityRequest**](UpdatePersonalityRequest.md)| |
|
|
1547
|
+
|
|
1548
|
+
### Return type
|
|
1549
|
+
|
|
1550
|
+
[**BankProfileResponse**](BankProfileResponse.md)
|
|
1551
|
+
|
|
1552
|
+
### Authorization
|
|
1553
|
+
|
|
1554
|
+
No authorization required
|
|
1555
|
+
|
|
1556
|
+
### HTTP request headers
|
|
1557
|
+
|
|
1558
|
+
- **Content-Type**: application/json
|
|
1559
|
+
- **Accept**: application/json
|
|
1560
|
+
|
|
1561
|
+
### HTTP response details
|
|
1562
|
+
|
|
1563
|
+
| Status code | Description | Response headers |
|
|
1564
|
+
|-------------|-------------|------------------|
|
|
1565
|
+
**200** | Successful Response | - |
|
|
1566
|
+
**422** | Validation Error | - |
|
|
1567
|
+
|
|
1568
|
+
[[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)
|
|
1569
|
+
|