hindsight-client 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

hindsight_client_api/docs/OperationsApi.md

@@ -1,154 +0,0 @@
-# hindsight_client_api.OperationsApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**cancel_operation**](OperationsApi.md#cancel_operation) | **DELETE** /v1/default/banks/{bank_id}/operations/{operation_id} | Cancel a pending async operation
-[**list_operations**](OperationsApi.md#list_operations) | **GET** /v1/default/banks/{bank_id}/operations | List async operations
-
-
-# **cancel_operation**
-> CancelOperationResponse cancel_operation(bank_id, operation_id, authorization=authorization)
-
-Cancel a pending async operation
-
-Cancel a pending async operation by removing it from the queue
-
-### Example
-
-
-```python
-import hindsight_client_api
-from hindsight_client_api.models.cancel_operation_response import CancelOperationResponse
-from hindsight_client_api.rest import ApiException
-from pprint import pprint
-
-# Defining the host is optional and defaults to http://localhost
-# See configuration.py for a list of all supported configuration parameters.
-configuration = hindsight_client_api.Configuration(
-    host = "http://localhost"
-)
-
-
-# Enter a context with an instance of the API client
-async with hindsight_client_api.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = hindsight_client_api.OperationsApi(api_client)
-    bank_id = 'bank_id_example' # str | 
-    operation_id = 'operation_id_example' # str | 
-    authorization = 'authorization_example' # str |  (optional)
-
-    try:
-        # Cancel a pending async operation
-        api_response = await api_instance.cancel_operation(bank_id, operation_id, authorization=authorization)
-        print("The response of OperationsApi->cancel_operation:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling OperationsApi->cancel_operation: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bank_id** | **str**|  | 
- **operation_id** | **str**|  | 
- **authorization** | **str**|  | [optional] 
-
-### Return type
-
-[**CancelOperationResponse**](CancelOperationResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful Response |  -  |
-**422** | Validation Error |  -  |
-
-[[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)
-
-# **list_operations**
-> OperationsListResponse list_operations(bank_id, authorization=authorization)
-
-List async operations
-
-Get a list of all async operations (pending and failed) for a specific agent, including error messages for failed operations
-
-### Example
-
-
-```python
-import hindsight_client_api
-from hindsight_client_api.models.operations_list_response import OperationsListResponse
-from hindsight_client_api.rest import ApiException
-from pprint import pprint
-
-# Defining the host is optional and defaults to http://localhost
-# See configuration.py for a list of all supported configuration parameters.
-configuration = hindsight_client_api.Configuration(
-    host = "http://localhost"
-)
-
-
-# Enter a context with an instance of the API client
-async with hindsight_client_api.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = hindsight_client_api.OperationsApi(api_client)
-    bank_id = 'bank_id_example' # str | 
-    authorization = 'authorization_example' # str |  (optional)
-
-    try:
-        # List async operations
-        api_response = await api_instance.list_operations(bank_id, authorization=authorization)
-        print("The response of OperationsApi->list_operations:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling OperationsApi->list_operations: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bank_id** | **str**|  | 
- **authorization** | **str**|  | [optional] 
-
-### Return type
-
-[**OperationsListResponse**](OperationsListResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successful Response |  -  |
-**422** | Validation Error |  -  |
-
-[[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)
-

hindsight_client_api/docs/OperationsListResponse.md

@@ -1,31 +0,0 @@
-# OperationsListResponse
-
-Response model for list operations endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bank_id** | **str** |  | 
-**operations** | [**List[OperationResponse]**](OperationResponse.md) |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.operations_list_response import OperationsListResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of OperationsListResponse from a JSON string
-operations_list_response_instance = OperationsListResponse.from_json(json)
-# print the JSON string representation of the object
-print(OperationsListResponse.to_json())
-
-# convert the object into a dict
-operations_list_response_dict = operations_list_response_instance.to_dict()
-# create an instance of OperationsListResponse from a dict
-operations_list_response_from_dict = OperationsListResponse.from_dict(operations_list_response_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/RecallRequest.md

@@ -1,36 +0,0 @@
-# RecallRequest
-
-Request model for recall endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**query** | **str** |  | 
-**types** | **List[str]** |  | [optional] 
-**budget** | [**Budget**](Budget.md) |  | [optional] 
-**max_tokens** | **int** |  | [optional] [default to 4096]
-**trace** | **bool** |  | [optional] [default to False]
-**query_timestamp** | **str** |  | [optional] 
-**include** | [**IncludeOptions**](IncludeOptions.md) | Options for including additional data (entities are included by default) | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.recall_request import RecallRequest
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of RecallRequest from a JSON string
-recall_request_instance = RecallRequest.from_json(json)
-# print the JSON string representation of the object
-print(RecallRequest.to_json())
-
-# convert the object into a dict
-recall_request_dict = recall_request_instance.to_dict()
-# create an instance of RecallRequest from a dict
-recall_request_from_dict = RecallRequest.from_dict(recall_request_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/RecallResponse.md

@@ -1,33 +0,0 @@
-# RecallResponse
-
-Response model for recall endpoints.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**results** | [**List[RecallResult]**](RecallResult.md) |  | 
-**trace** | **Dict[str, object]** |  | [optional] 
-**entities** | [**Dict[str, EntityStateResponse]**](EntityStateResponse.md) |  | [optional] 
-**chunks** | [**Dict[str, ChunkData]**](ChunkData.md) |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.recall_response import RecallResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of RecallResponse from a JSON string
-recall_response_instance = RecallResponse.from_json(json)
-# print the JSON string representation of the object
-print(RecallResponse.to_json())
-
-# convert the object into a dict
-recall_response_dict = recall_response_instance.to_dict()
-# create an instance of RecallResponse from a dict
-recall_response_from_dict = RecallResponse.from_dict(recall_response_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/RecallResult.md

@@ -1,40 +0,0 @@
-# RecallResult
-
-Single recall result item.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** |  | 
-**text** | **str** |  | 
-**type** | **str** |  | [optional] 
-**entities** | **List[str]** |  | [optional] 
-**context** | **str** |  | [optional] 
-**occurred_start** | **str** |  | [optional] 
-**occurred_end** | **str** |  | [optional] 
-**mentioned_at** | **str** |  | [optional] 
-**document_id** | **str** |  | [optional] 
-**metadata** | **Dict[str, str]** |  | [optional] 
-**chunk_id** | **str** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.recall_result import RecallResult
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of RecallResult from a JSON string
-recall_result_instance = RecallResult.from_json(json)
-# print the JSON string representation of the object
-print(RecallResult.to_json())
-
-# convert the object into a dict
-recall_result_dict = recall_result_instance.to_dict()
-# create an instance of RecallResult from a dict
-recall_result_from_dict = RecallResult.from_dict(recall_result_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ReflectFact.md

@@ -1,35 +0,0 @@
-# ReflectFact
-
-A fact used in think response.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** |  | [optional] 
-**text** | **str** |  | 
-**type** | **str** |  | [optional] 
-**context** | **str** |  | [optional] 
-**occurred_start** | **str** |  | [optional] 
-**occurred_end** | **str** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.reflect_fact import ReflectFact
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ReflectFact from a JSON string
-reflect_fact_instance = ReflectFact.from_json(json)
-# print the JSON string representation of the object
-print(ReflectFact.to_json())
-
-# convert the object into a dict
-reflect_fact_dict = reflect_fact_instance.to_dict()
-# create an instance of ReflectFact from a dict
-reflect_fact_from_dict = ReflectFact.from_dict(reflect_fact_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ReflectIncludeOptions.md

@@ -1,30 +0,0 @@
-# ReflectIncludeOptions
-
-Options for including additional data in reflect results.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**facts** | **object** | Options for including facts (based_on) in reflect results. | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.reflect_include_options import ReflectIncludeOptions
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ReflectIncludeOptions from a JSON string
-reflect_include_options_instance = ReflectIncludeOptions.from_json(json)
-# print the JSON string representation of the object
-print(ReflectIncludeOptions.to_json())
-
-# convert the object into a dict
-reflect_include_options_dict = reflect_include_options_instance.to_dict()
-# create an instance of ReflectIncludeOptions from a dict
-reflect_include_options_from_dict = ReflectIncludeOptions.from_dict(reflect_include_options_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ReflectRequest.md

@@ -1,35 +0,0 @@
-# ReflectRequest
-
-Request model for reflect endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**query** | **str** |  | 
-**budget** | [**Budget**](Budget.md) |  | [optional] 
-**context** | **str** |  | [optional] 
-**max_tokens** | **int** | Maximum tokens for the response | [optional] [default to 4096]
-**include** | [**ReflectIncludeOptions**](ReflectIncludeOptions.md) | Options for including additional data (disabled by default) | [optional] 
-**response_schema** | **Dict[str, object]** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.reflect_request import ReflectRequest
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ReflectRequest from a JSON string
-reflect_request_instance = ReflectRequest.from_json(json)
-# print the JSON string representation of the object
-print(ReflectRequest.to_json())
-
-# convert the object into a dict
-reflect_request_dict = reflect_request_instance.to_dict()
-# create an instance of ReflectRequest from a dict
-reflect_request_from_dict = ReflectRequest.from_dict(reflect_request_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ReflectResponse.md

@@ -1,32 +0,0 @@
-# ReflectResponse
-
-Response model for think endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **str** |  | 
-**based_on** | [**List[ReflectFact]**](ReflectFact.md) |  | [optional] [default to []]
-**structured_output** | **Dict[str, object]** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.reflect_response import ReflectResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ReflectResponse from a JSON string
-reflect_response_instance = ReflectResponse.from_json(json)
-# print the JSON string representation of the object
-print(ReflectResponse.to_json())
-
-# convert the object into a dict
-reflect_response_dict = reflect_response_instance.to_dict()
-# create an instance of ReflectResponse from a dict
-reflect_response_from_dict = ReflectResponse.from_dict(reflect_response_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/RetainRequest.md

@@ -1,31 +0,0 @@
-# RetainRequest
-
-Request model for retain endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**List[MemoryItem]**](MemoryItem.md) |  | 
-**var_async** | **bool** | If true, process asynchronously in background. If false, wait for completion (default: false) | [optional] [default to False]
-
-## Example
-
-```python
-from hindsight_client_api.models.retain_request import RetainRequest
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of RetainRequest from a JSON string
-retain_request_instance = RetainRequest.from_json(json)
-# print the JSON string representation of the object
-print(RetainRequest.to_json())
-
-# convert the object into a dict
-retain_request_dict = retain_request_instance.to_dict()
-# create an instance of RetainRequest from a dict
-retain_request_from_dict = RetainRequest.from_dict(retain_request_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/RetainResponse.md

@@ -1,33 +0,0 @@
-# RetainResponse
-
-Response model for retain endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **bool** |  | 
-**bank_id** | **str** |  | 
-**items_count** | **int** |  | 
-**var_async** | **bool** | Whether the operation was processed asynchronously | 
-
-## Example
-
-```python
-from hindsight_client_api.models.retain_response import RetainResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of RetainResponse from a JSON string
-retain_response_instance = RetainResponse.from_json(json)
-# print the JSON string representation of the object
-print(RetainResponse.to_json())
-
-# convert the object into a dict
-retain_response_dict = retain_response_instance.to_dict()
-# create an instance of RetainResponse from a dict
-retain_response_from_dict = RetainResponse.from_dict(retain_response_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/UpdateDispositionRequest.md

@@ -1,30 +0,0 @@
-# UpdateDispositionRequest
-
-Request model for updating disposition traits.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**disposition** | [**DispositionTraits**](DispositionTraits.md) |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.update_disposition_request import UpdateDispositionRequest
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of UpdateDispositionRequest from a JSON string
-update_disposition_request_instance = UpdateDispositionRequest.from_json(json)
-# print the JSON string representation of the object
-print(UpdateDispositionRequest.to_json())
-
-# convert the object into a dict
-update_disposition_request_dict = update_disposition_request_instance.to_dict()
-# create an instance of UpdateDispositionRequest from a dict
-update_disposition_request_from_dict = UpdateDispositionRequest.from_dict(update_disposition_request_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ValidationError.md

@@ -1,31 +0,0 @@
-# ValidationError
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) |  | 
-**msg** | **str** |  | 
-**type** | **str** |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.validation_error import ValidationError
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ValidationError from a JSON string
-validation_error_instance = ValidationError.from_json(json)
-# print the JSON string representation of the object
-print(ValidationError.to_json())
-
-# convert the object into a dict
-validation_error_dict = validation_error_instance.to_dict()
-# create an instance of ValidationError from a dict
-validation_error_from_dict = ValidationError.from_dict(validation_error_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

hindsight_client_api/docs/ValidationErrorLocInner.md

@@ -1,28 +0,0 @@
-# ValidationErrorLocInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```python
-from hindsight_client_api.models.validation_error_loc_inner import ValidationErrorLocInner
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ValidationErrorLocInner from a JSON string
-validation_error_loc_inner_instance = ValidationErrorLocInner.from_json(json)
-# print the JSON string representation of the object
-print(ValidationErrorLocInner.to_json())
-
-# convert the object into a dict
-validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict()
-# create an instance of ValidationErrorLocInner from a dict
-validation_error_loc_inner_from_dict = ValidationErrorLocInner.from_dict(validation_error_loc_inner_dict)
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-