hindsight-client 0.1.16__py3-none-any.whl → 0.2.1__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 (63) hide show
  1. hindsight_client/hindsight_client.py +58 -25
  2. {hindsight_client-0.1.16.dist-info → hindsight_client-0.2.1.dist-info}/METADATA +1 -1
  3. hindsight_client-0.2.1.dist-info/RECORD +62 -0
  4. hindsight_client_api/__init__.py +58 -119
  5. hindsight_client_api/api_client.py +6 -13
  6. hindsight_client_api/configuration.py +4 -15
  7. hindsight_client_api/exceptions.py +2 -22
  8. hindsight_client_api/models/__init__.py +2 -1
  9. hindsight_client_api/models/entity_input.py +94 -0
  10. hindsight_client_api/models/memory_item.py +17 -2
  11. hindsight_client_api/models/reflect_request.py +12 -3
  12. hindsight_client_api/models/reflect_response.py +9 -2
  13. hindsight_client_api/rest.py +60 -38
  14. hindsight_client-0.1.16.dist-info/RECORD +0 -109
  15. hindsight_client_api/docs/AddBackgroundRequest.md +0 -31
  16. hindsight_client_api/docs/BackgroundResponse.md +0 -31
  17. hindsight_client_api/docs/BankListItem.md +0 -35
  18. hindsight_client_api/docs/BankListResponse.md +0 -30
  19. hindsight_client_api/docs/BankProfileResponse.md +0 -33
  20. hindsight_client_api/docs/BankStatsResponse.md +0 -39
  21. hindsight_client_api/docs/BanksApi.md +0 -517
  22. hindsight_client_api/docs/Budget.md +0 -15
  23. hindsight_client_api/docs/CancelOperationResponse.md +0 -32
  24. hindsight_client_api/docs/ChunkData.md +0 -33
  25. hindsight_client_api/docs/ChunkIncludeOptions.md +0 -30
  26. hindsight_client_api/docs/ChunkResponse.md +0 -35
  27. hindsight_client_api/docs/CreateBankRequest.md +0 -32
  28. hindsight_client_api/docs/DeleteDocumentResponse.md +0 -33
  29. hindsight_client_api/docs/DeleteResponse.md +0 -32
  30. hindsight_client_api/docs/DispositionTraits.md +0 -32
  31. hindsight_client_api/docs/DocumentResponse.md +0 -36
  32. hindsight_client_api/docs/DocumentsApi.md +0 -313
  33. hindsight_client_api/docs/EntitiesApi.md +0 -230
  34. hindsight_client_api/docs/EntityDetailResponse.md +0 -36
  35. hindsight_client_api/docs/EntityIncludeOptions.md +0 -30
  36. hindsight_client_api/docs/EntityListItem.md +0 -35
  37. hindsight_client_api/docs/EntityListResponse.md +0 -30
  38. hindsight_client_api/docs/EntityObservationResponse.md +0 -31
  39. hindsight_client_api/docs/EntityStateResponse.md +0 -32
  40. hindsight_client_api/docs/GraphDataResponse.md +0 -33
  41. hindsight_client_api/docs/HTTPValidationError.md +0 -29
  42. hindsight_client_api/docs/IncludeOptions.md +0 -31
  43. hindsight_client_api/docs/ListDocumentsResponse.md +0 -33
  44. hindsight_client_api/docs/ListMemoryUnitsResponse.md +0 -33
  45. hindsight_client_api/docs/MemoryApi.md +0 -499
  46. hindsight_client_api/docs/MemoryItem.md +0 -34
  47. hindsight_client_api/docs/MonitoringApi.md +0 -136
  48. hindsight_client_api/docs/OperationResponse.md +0 -36
  49. hindsight_client_api/docs/OperationsApi.md +0 -154
  50. hindsight_client_api/docs/OperationsListResponse.md +0 -31
  51. hindsight_client_api/docs/RecallRequest.md +0 -36
  52. hindsight_client_api/docs/RecallResponse.md +0 -33
  53. hindsight_client_api/docs/RecallResult.md +0 -40
  54. hindsight_client_api/docs/ReflectFact.md +0 -35
  55. hindsight_client_api/docs/ReflectIncludeOptions.md +0 -30
  56. hindsight_client_api/docs/ReflectRequest.md +0 -33
  57. hindsight_client_api/docs/ReflectResponse.md +0 -31
  58. hindsight_client_api/docs/RetainRequest.md +0 -31
  59. hindsight_client_api/docs/RetainResponse.md +0 -33
  60. hindsight_client_api/docs/UpdateDispositionRequest.md +0 -30
  61. hindsight_client_api/docs/ValidationError.md +0 -31
  62. hindsight_client_api/docs/ValidationErrorLocInner.md +0 -28
  63. {hindsight_client-0.1.16.dist-info → hindsight_client-0.2.1.dist-info}/WHEEL +0 -0
@@ -1,32 +0,0 @@
1
- # CreateBankRequest
2
-
3
- Request model for creating/updating a bank.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **name** | **str** | | [optional]
10
- **disposition** | [**DispositionTraits**](DispositionTraits.md) | | [optional]
11
- **background** | **str** | | [optional]
12
-
13
- ## Example
14
-
15
- ```python
16
- from hindsight_client_api.models.create_bank_request import CreateBankRequest
17
-
18
- # TODO update the JSON string below
19
- json = "{}"
20
- # create an instance of CreateBankRequest from a JSON string
21
- create_bank_request_instance = CreateBankRequest.from_json(json)
22
- # print the JSON string representation of the object
23
- print(CreateBankRequest.to_json())
24
-
25
- # convert the object into a dict
26
- create_bank_request_dict = create_bank_request_instance.to_dict()
27
- # create an instance of CreateBankRequest from a dict
28
- create_bank_request_from_dict = CreateBankRequest.from_dict(create_bank_request_dict)
29
- ```
30
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31
-
32
-
@@ -1,33 +0,0 @@
1
- # DeleteDocumentResponse
2
-
3
- Response model for delete document endpoint.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **success** | **bool** | |
10
- **message** | **str** | |
11
- **document_id** | **str** | |
12
- **memory_units_deleted** | **int** | |
13
-
14
- ## Example
15
-
16
- ```python
17
- from hindsight_client_api.models.delete_document_response import DeleteDocumentResponse
18
-
19
- # TODO update the JSON string below
20
- json = "{}"
21
- # create an instance of DeleteDocumentResponse from a JSON string
22
- delete_document_response_instance = DeleteDocumentResponse.from_json(json)
23
- # print the JSON string representation of the object
24
- print(DeleteDocumentResponse.to_json())
25
-
26
- # convert the object into a dict
27
- delete_document_response_dict = delete_document_response_instance.to_dict()
28
- # create an instance of DeleteDocumentResponse from a dict
29
- delete_document_response_from_dict = DeleteDocumentResponse.from_dict(delete_document_response_dict)
30
- ```
31
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32
-
33
-
@@ -1,32 +0,0 @@
1
- # DeleteResponse
2
-
3
- Response model for delete operations.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **success** | **bool** | |
10
- **message** | **str** | | [optional]
11
- **deleted_count** | **int** | | [optional]
12
-
13
- ## Example
14
-
15
- ```python
16
- from hindsight_client_api.models.delete_response import DeleteResponse
17
-
18
- # TODO update the JSON string below
19
- json = "{}"
20
- # create an instance of DeleteResponse from a JSON string
21
- delete_response_instance = DeleteResponse.from_json(json)
22
- # print the JSON string representation of the object
23
- print(DeleteResponse.to_json())
24
-
25
- # convert the object into a dict
26
- delete_response_dict = delete_response_instance.to_dict()
27
- # create an instance of DeleteResponse from a dict
28
- delete_response_from_dict = DeleteResponse.from_dict(delete_response_dict)
29
- ```
30
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31
-
32
-
@@ -1,32 +0,0 @@
1
- # DispositionTraits
2
-
3
- Disposition traits that influence how memories are formed and interpreted.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **skepticism** | **int** | How skeptical vs trusting (1=trusting, 5=skeptical) |
10
- **literalism** | **int** | How literally to interpret information (1=flexible, 5=literal) |
11
- **empathy** | **int** | How much to consider emotional context (1=detached, 5=empathetic) |
12
-
13
- ## Example
14
-
15
- ```python
16
- from hindsight_client_api.models.disposition_traits import DispositionTraits
17
-
18
- # TODO update the JSON string below
19
- json = "{}"
20
- # create an instance of DispositionTraits from a JSON string
21
- disposition_traits_instance = DispositionTraits.from_json(json)
22
- # print the JSON string representation of the object
23
- print(DispositionTraits.to_json())
24
-
25
- # convert the object into a dict
26
- disposition_traits_dict = disposition_traits_instance.to_dict()
27
- # create an instance of DispositionTraits from a dict
28
- disposition_traits_from_dict = DispositionTraits.from_dict(disposition_traits_dict)
29
- ```
30
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31
-
32
-
@@ -1,36 +0,0 @@
1
- # DocumentResponse
2
-
3
- Response model for get document endpoint.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **str** | |
10
- **bank_id** | **str** | |
11
- **original_text** | **str** | |
12
- **content_hash** | **str** | |
13
- **created_at** | **str** | |
14
- **updated_at** | **str** | |
15
- **memory_unit_count** | **int** | |
16
-
17
- ## Example
18
-
19
- ```python
20
- from hindsight_client_api.models.document_response import DocumentResponse
21
-
22
- # TODO update the JSON string below
23
- json = "{}"
24
- # create an instance of DocumentResponse from a JSON string
25
- document_response_instance = DocumentResponse.from_json(json)
26
- # print the JSON string representation of the object
27
- print(DocumentResponse.to_json())
28
-
29
- # convert the object into a dict
30
- document_response_dict = document_response_instance.to_dict()
31
- # create an instance of DocumentResponse from a dict
32
- document_response_from_dict = DocumentResponse.from_dict(document_response_dict)
33
- ```
34
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
35
-
36
-
@@ -1,313 +0,0 @@
1
- # hindsight_client_api.DocumentsApi
2
-
3
- All URIs are relative to *http://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delete_document**](DocumentsApi.md#delete_document) | **DELETE** /v1/default/banks/{bank_id}/documents/{document_id} | Delete a document
8
- [**get_chunk**](DocumentsApi.md#get_chunk) | **GET** /v1/default/chunks/{chunk_id} | Get chunk details
9
- [**get_document**](DocumentsApi.md#get_document) | **GET** /v1/default/banks/{bank_id}/documents/{document_id} | Get document details
10
- [**list_documents**](DocumentsApi.md#list_documents) | **GET** /v1/default/banks/{bank_id}/documents | List documents
11
-
12
-
13
- # **delete_document**
14
- > DeleteDocumentResponse delete_document(bank_id, document_id, authorization=authorization)
15
-
16
- Delete a document
17
-
18
- Delete a document and all its associated memory units and links.
19
-
20
- This will cascade delete:
21
- - The document itself
22
- - All memory units extracted from this document
23
- - All links (temporal, semantic, entity) associated with those memory units
24
-
25
- This operation cannot be undone.
26
-
27
- ### Example
28
-
29
-
30
- ```python
31
- import hindsight_client_api
32
- from hindsight_client_api.models.delete_document_response import DeleteDocumentResponse
33
- from hindsight_client_api.rest import ApiException
34
- from pprint import pprint
35
-
36
- # Defining the host is optional and defaults to http://localhost
37
- # See configuration.py for a list of all supported configuration parameters.
38
- configuration = hindsight_client_api.Configuration(
39
- host = "http://localhost"
40
- )
41
-
42
-
43
- # Enter a context with an instance of the API client
44
- async with hindsight_client_api.ApiClient(configuration) as api_client:
45
- # Create an instance of the API class
46
- api_instance = hindsight_client_api.DocumentsApi(api_client)
47
- bank_id = 'bank_id_example' # str |
48
- document_id = 'document_id_example' # str |
49
- authorization = 'authorization_example' # str | (optional)
50
-
51
- try:
52
- # Delete a document
53
- api_response = await api_instance.delete_document(bank_id, document_id, authorization=authorization)
54
- print("The response of DocumentsApi->delete_document:\n")
55
- pprint(api_response)
56
- except Exception as e:
57
- print("Exception when calling DocumentsApi->delete_document: %s\n" % e)
58
- ```
59
-
60
-
61
-
62
- ### Parameters
63
-
64
-
65
- Name | Type | Description | Notes
66
- ------------- | ------------- | ------------- | -------------
67
- **bank_id** | **str**| |
68
- **document_id** | **str**| |
69
- **authorization** | **str**| | [optional]
70
-
71
- ### Return type
72
-
73
- [**DeleteDocumentResponse**](DeleteDocumentResponse.md)
74
-
75
- ### Authorization
76
-
77
- No authorization required
78
-
79
- ### HTTP request headers
80
-
81
- - **Content-Type**: Not defined
82
- - **Accept**: application/json
83
-
84
- ### HTTP response details
85
-
86
- | Status code | Description | Response headers |
87
- |-------------|-------------|------------------|
88
- **200** | Successful Response | - |
89
- **422** | Validation Error | - |
90
-
91
- [[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)
92
-
93
- # **get_chunk**
94
- > ChunkResponse get_chunk(chunk_id, authorization=authorization)
95
-
96
- Get chunk details
97
-
98
- Get a specific chunk by its ID
99
-
100
- ### Example
101
-
102
-
103
- ```python
104
- import hindsight_client_api
105
- from hindsight_client_api.models.chunk_response import ChunkResponse
106
- from hindsight_client_api.rest import ApiException
107
- from pprint import pprint
108
-
109
- # Defining the host is optional and defaults to http://localhost
110
- # See configuration.py for a list of all supported configuration parameters.
111
- configuration = hindsight_client_api.Configuration(
112
- host = "http://localhost"
113
- )
114
-
115
-
116
- # Enter a context with an instance of the API client
117
- async with hindsight_client_api.ApiClient(configuration) as api_client:
118
- # Create an instance of the API class
119
- api_instance = hindsight_client_api.DocumentsApi(api_client)
120
- chunk_id = 'chunk_id_example' # str |
121
- authorization = 'authorization_example' # str | (optional)
122
-
123
- try:
124
- # Get chunk details
125
- api_response = await api_instance.get_chunk(chunk_id, authorization=authorization)
126
- print("The response of DocumentsApi->get_chunk:\n")
127
- pprint(api_response)
128
- except Exception as e:
129
- print("Exception when calling DocumentsApi->get_chunk: %s\n" % e)
130
- ```
131
-
132
-
133
-
134
- ### Parameters
135
-
136
-
137
- Name | Type | Description | Notes
138
- ------------- | ------------- | ------------- | -------------
139
- **chunk_id** | **str**| |
140
- **authorization** | **str**| | [optional]
141
-
142
- ### Return type
143
-
144
- [**ChunkResponse**](ChunkResponse.md)
145
-
146
- ### Authorization
147
-
148
- No authorization required
149
-
150
- ### HTTP request headers
151
-
152
- - **Content-Type**: Not defined
153
- - **Accept**: application/json
154
-
155
- ### HTTP response details
156
-
157
- | Status code | Description | Response headers |
158
- |-------------|-------------|------------------|
159
- **200** | Successful Response | - |
160
- **422** | Validation Error | - |
161
-
162
- [[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)
163
-
164
- # **get_document**
165
- > DocumentResponse get_document(bank_id, document_id, authorization=authorization)
166
-
167
- Get document details
168
-
169
- Get a specific document including its original text
170
-
171
- ### Example
172
-
173
-
174
- ```python
175
- import hindsight_client_api
176
- from hindsight_client_api.models.document_response import DocumentResponse
177
- from hindsight_client_api.rest import ApiException
178
- from pprint import pprint
179
-
180
- # Defining the host is optional and defaults to http://localhost
181
- # See configuration.py for a list of all supported configuration parameters.
182
- configuration = hindsight_client_api.Configuration(
183
- host = "http://localhost"
184
- )
185
-
186
-
187
- # Enter a context with an instance of the API client
188
- async with hindsight_client_api.ApiClient(configuration) as api_client:
189
- # Create an instance of the API class
190
- api_instance = hindsight_client_api.DocumentsApi(api_client)
191
- bank_id = 'bank_id_example' # str |
192
- document_id = 'document_id_example' # str |
193
- authorization = 'authorization_example' # str | (optional)
194
-
195
- try:
196
- # Get document details
197
- api_response = await api_instance.get_document(bank_id, document_id, authorization=authorization)
198
- print("The response of DocumentsApi->get_document:\n")
199
- pprint(api_response)
200
- except Exception as e:
201
- print("Exception when calling DocumentsApi->get_document: %s\n" % e)
202
- ```
203
-
204
-
205
-
206
- ### Parameters
207
-
208
-
209
- Name | Type | Description | Notes
210
- ------------- | ------------- | ------------- | -------------
211
- **bank_id** | **str**| |
212
- **document_id** | **str**| |
213
- **authorization** | **str**| | [optional]
214
-
215
- ### Return type
216
-
217
- [**DocumentResponse**](DocumentResponse.md)
218
-
219
- ### Authorization
220
-
221
- No authorization required
222
-
223
- ### HTTP request headers
224
-
225
- - **Content-Type**: Not defined
226
- - **Accept**: application/json
227
-
228
- ### HTTP response details
229
-
230
- | Status code | Description | Response headers |
231
- |-------------|-------------|------------------|
232
- **200** | Successful Response | - |
233
- **422** | Validation Error | - |
234
-
235
- [[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)
236
-
237
- # **list_documents**
238
- > ListDocumentsResponse list_documents(bank_id, q=q, limit=limit, offset=offset, authorization=authorization)
239
-
240
- List documents
241
-
242
- List documents with pagination and optional search. Documents are the source content from which memory units are extracted.
243
-
244
- ### Example
245
-
246
-
247
- ```python
248
- import hindsight_client_api
249
- from hindsight_client_api.models.list_documents_response import ListDocumentsResponse
250
- from hindsight_client_api.rest import ApiException
251
- from pprint import pprint
252
-
253
- # Defining the host is optional and defaults to http://localhost
254
- # See configuration.py for a list of all supported configuration parameters.
255
- configuration = hindsight_client_api.Configuration(
256
- host = "http://localhost"
257
- )
258
-
259
-
260
- # Enter a context with an instance of the API client
261
- async with hindsight_client_api.ApiClient(configuration) as api_client:
262
- # Create an instance of the API class
263
- api_instance = hindsight_client_api.DocumentsApi(api_client)
264
- bank_id = 'bank_id_example' # str |
265
- q = 'q_example' # str | (optional)
266
- limit = 100 # int | (optional) (default to 100)
267
- offset = 0 # int | (optional) (default to 0)
268
- authorization = 'authorization_example' # str | (optional)
269
-
270
- try:
271
- # List documents
272
- api_response = await api_instance.list_documents(bank_id, q=q, limit=limit, offset=offset, authorization=authorization)
273
- print("The response of DocumentsApi->list_documents:\n")
274
- pprint(api_response)
275
- except Exception as e:
276
- print("Exception when calling DocumentsApi->list_documents: %s\n" % e)
277
- ```
278
-
279
-
280
-
281
- ### Parameters
282
-
283
-
284
- Name | Type | Description | Notes
285
- ------------- | ------------- | ------------- | -------------
286
- **bank_id** | **str**| |
287
- **q** | **str**| | [optional]
288
- **limit** | **int**| | [optional] [default to 100]
289
- **offset** | **int**| | [optional] [default to 0]
290
- **authorization** | **str**| | [optional]
291
-
292
- ### Return type
293
-
294
- [**ListDocumentsResponse**](ListDocumentsResponse.md)
295
-
296
- ### Authorization
297
-
298
- No authorization required
299
-
300
- ### HTTP request headers
301
-
302
- - **Content-Type**: Not defined
303
- - **Accept**: application/json
304
-
305
- ### HTTP response details
306
-
307
- | Status code | Description | Response headers |
308
- |-------------|-------------|------------------|
309
- **200** | Successful Response | - |
310
- **422** | Validation Error | - |
311
-
312
- [[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)
313
-