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

hindsight_client_api/docs/EntitiesApi.md

@@ -1,230 +0,0 @@
-# hindsight_client_api.EntitiesApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_entity**](EntitiesApi.md#get_entity) | **GET** /v1/default/banks/{bank_id}/entities/{entity_id} | Get entity details
-[**list_entities**](EntitiesApi.md#list_entities) | **GET** /v1/default/banks/{bank_id}/entities | List entities
-[**regenerate_entity_observations**](EntitiesApi.md#regenerate_entity_observations) | **POST** /v1/default/banks/{bank_id}/entities/{entity_id}/regenerate | Regenerate entity observations
-
-
-# **get_entity**
-> EntityDetailResponse get_entity(bank_id, entity_id, authorization=authorization)
-
-Get entity details
-
-Get detailed information about an entity including observations (mental model).
-
-### Example
-
-
-```python
-import hindsight_client_api
-from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
-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.EntitiesApi(api_client)
-    bank_id = 'bank_id_example' # str | 
-    entity_id = 'entity_id_example' # str | 
-    authorization = 'authorization_example' # str |  (optional)
-
-    try:
-        # Get entity details
-        api_response = await api_instance.get_entity(bank_id, entity_id, authorization=authorization)
-        print("The response of EntitiesApi->get_entity:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling EntitiesApi->get_entity: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bank_id** | **str**|  | 
- **entity_id** | **str**|  | 
- **authorization** | **str**|  | [optional] 
-
-### Return type
-
-[**EntityDetailResponse**](EntityDetailResponse.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_entities**
-> EntityListResponse list_entities(bank_id, limit=limit, authorization=authorization)
-
-List entities
-
-List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
-
-### Example
-
-
-```python
-import hindsight_client_api
-from hindsight_client_api.models.entity_list_response import EntityListResponse
-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.EntitiesApi(api_client)
-    bank_id = 'bank_id_example' # str | 
-    limit = 100 # int | Maximum number of entities to return (optional) (default to 100)
-    authorization = 'authorization_example' # str |  (optional)
-
-    try:
-        # List entities
-        api_response = await api_instance.list_entities(bank_id, limit=limit, authorization=authorization)
-        print("The response of EntitiesApi->list_entities:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling EntitiesApi->list_entities: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bank_id** | **str**|  | 
- **limit** | **int**| Maximum number of entities to return | [optional] [default to 100]
- **authorization** | **str**|  | [optional] 
-
-### Return type
-
-[**EntityListResponse**](EntityListResponse.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)
-
-# **regenerate_entity_observations**
-> EntityDetailResponse regenerate_entity_observations(bank_id, entity_id, authorization=authorization)
-
-Regenerate entity observations
-
-Regenerate observations for an entity based on all facts mentioning it.
-
-### Example
-
-
-```python
-import hindsight_client_api
-from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
-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.EntitiesApi(api_client)
-    bank_id = 'bank_id_example' # str | 
-    entity_id = 'entity_id_example' # str | 
-    authorization = 'authorization_example' # str |  (optional)
-
-    try:
-        # Regenerate entity observations
-        api_response = await api_instance.regenerate_entity_observations(bank_id, entity_id, authorization=authorization)
-        print("The response of EntitiesApi->regenerate_entity_observations:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling EntitiesApi->regenerate_entity_observations: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bank_id** | **str**|  | 
- **entity_id** | **str**|  | 
- **authorization** | **str**|  | [optional] 
-
-### Return type
-
-[**EntityDetailResponse**](EntityDetailResponse.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/EntityDetailResponse.md

@@ -1,36 +0,0 @@
-# EntityDetailResponse
-
-Response model for entity detail endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** |  | 
-**canonical_name** | **str** |  | 
-**mention_count** | **int** |  | 
-**first_seen** | **str** |  | [optional] 
-**last_seen** | **str** |  | [optional] 
-**metadata** | **Dict[str, object]** |  | [optional] 
-**observations** | [**List[EntityObservationResponse]**](EntityObservationResponse.md) |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityDetailResponse from a JSON string
-entity_detail_response_instance = EntityDetailResponse.from_json(json)
-# print the JSON string representation of the object
-print(EntityDetailResponse.to_json())
-
-# convert the object into a dict
-entity_detail_response_dict = entity_detail_response_instance.to_dict()
-# create an instance of EntityDetailResponse from a dict
-entity_detail_response_from_dict = EntityDetailResponse.from_dict(entity_detail_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/EntityIncludeOptions.md

@@ -1,30 +0,0 @@
-# EntityIncludeOptions
-
-Options for including entity observations in recall results.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**max_tokens** | **int** | Maximum tokens for entity observations | [optional] [default to 500]
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_include_options import EntityIncludeOptions
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityIncludeOptions from a JSON string
-entity_include_options_instance = EntityIncludeOptions.from_json(json)
-# print the JSON string representation of the object
-print(EntityIncludeOptions.to_json())
-
-# convert the object into a dict
-entity_include_options_dict = entity_include_options_instance.to_dict()
-# create an instance of EntityIncludeOptions from a dict
-entity_include_options_from_dict = EntityIncludeOptions.from_dict(entity_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/EntityListItem.md

@@ -1,35 +0,0 @@
-# EntityListItem
-
-Entity list item with summary.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** |  | 
-**canonical_name** | **str** |  | 
-**mention_count** | **int** |  | 
-**first_seen** | **str** |  | [optional] 
-**last_seen** | **str** |  | [optional] 
-**metadata** | **Dict[str, object]** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_list_item import EntityListItem
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityListItem from a JSON string
-entity_list_item_instance = EntityListItem.from_json(json)
-# print the JSON string representation of the object
-print(EntityListItem.to_json())
-
-# convert the object into a dict
-entity_list_item_dict = entity_list_item_instance.to_dict()
-# create an instance of EntityListItem from a dict
-entity_list_item_from_dict = EntityListItem.from_dict(entity_list_item_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/EntityListResponse.md

@@ -1,30 +0,0 @@
-# EntityListResponse
-
-Response model for entity list endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**List[EntityListItem]**](EntityListItem.md) |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_list_response import EntityListResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityListResponse from a JSON string
-entity_list_response_instance = EntityListResponse.from_json(json)
-# print the JSON string representation of the object
-print(EntityListResponse.to_json())
-
-# convert the object into a dict
-entity_list_response_dict = entity_list_response_instance.to_dict()
-# create an instance of EntityListResponse from a dict
-entity_list_response_from_dict = EntityListResponse.from_dict(entity_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/EntityObservationResponse.md

@@ -1,31 +0,0 @@
-# EntityObservationResponse
-
-An observation about an entity.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **str** |  | 
-**mentioned_at** | **str** |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_observation_response import EntityObservationResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityObservationResponse from a JSON string
-entity_observation_response_instance = EntityObservationResponse.from_json(json)
-# print the JSON string representation of the object
-print(EntityObservationResponse.to_json())
-
-# convert the object into a dict
-entity_observation_response_dict = entity_observation_response_instance.to_dict()
-# create an instance of EntityObservationResponse from a dict
-entity_observation_response_from_dict = EntityObservationResponse.from_dict(entity_observation_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/EntityStateResponse.md

@@ -1,32 +0,0 @@
-# EntityStateResponse
-
-Current mental model of an entity.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**entity_id** | **str** |  | 
-**canonical_name** | **str** |  | 
-**observations** | [**List[EntityObservationResponse]**](EntityObservationResponse.md) |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.entity_state_response import EntityStateResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of EntityStateResponse from a JSON string
-entity_state_response_instance = EntityStateResponse.from_json(json)
-# print the JSON string representation of the object
-print(EntityStateResponse.to_json())
-
-# convert the object into a dict
-entity_state_response_dict = entity_state_response_instance.to_dict()
-# create an instance of EntityStateResponse from a dict
-entity_state_response_from_dict = EntityStateResponse.from_dict(entity_state_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/GraphDataResponse.md

@@ -1,33 +0,0 @@
-# GraphDataResponse
-
-Response model for graph data endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**nodes** | **List[Dict[str, object]]** |  | 
-**edges** | **List[Dict[str, object]]** |  | 
-**table_rows** | **List[Dict[str, object]]** |  | 
-**total_units** | **int** |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.graph_data_response import GraphDataResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of GraphDataResponse from a JSON string
-graph_data_response_instance = GraphDataResponse.from_json(json)
-# print the JSON string representation of the object
-print(GraphDataResponse.to_json())
-
-# convert the object into a dict
-graph_data_response_dict = graph_data_response_instance.to_dict()
-# create an instance of GraphDataResponse from a dict
-graph_data_response_from_dict = GraphDataResponse.from_dict(graph_data_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/HTTPValidationError.md

@@ -1,29 +0,0 @@
-# HTTPValidationError
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**detail** | [**List[ValidationError]**](ValidationError.md) |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.http_validation_error import HTTPValidationError
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of HTTPValidationError from a JSON string
-http_validation_error_instance = HTTPValidationError.from_json(json)
-# print the JSON string representation of the object
-print(HTTPValidationError.to_json())
-
-# convert the object into a dict
-http_validation_error_dict = http_validation_error_instance.to_dict()
-# create an instance of HTTPValidationError from a dict
-http_validation_error_from_dict = HTTPValidationError.from_dict(http_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/IncludeOptions.md

@@ -1,31 +0,0 @@
-# IncludeOptions
-
-Options for including additional data in recall results.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**entities** | [**EntityIncludeOptions**](EntityIncludeOptions.md) |  | [optional] 
-**chunks** | [**ChunkIncludeOptions**](ChunkIncludeOptions.md) |  | [optional] 
-
-## Example
-
-```python
-from hindsight_client_api.models.include_options import IncludeOptions
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of IncludeOptions from a JSON string
-include_options_instance = IncludeOptions.from_json(json)
-# print the JSON string representation of the object
-print(IncludeOptions.to_json())
-
-# convert the object into a dict
-include_options_dict = include_options_instance.to_dict()
-# create an instance of IncludeOptions from a dict
-include_options_from_dict = IncludeOptions.from_dict(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/ListDocumentsResponse.md

@@ -1,33 +0,0 @@
-# ListDocumentsResponse
-
-Response model for list documents endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | **List[Dict[str, object]]** |  | 
-**total** | **int** |  | 
-**limit** | **int** |  | 
-**offset** | **int** |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.list_documents_response import ListDocumentsResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ListDocumentsResponse from a JSON string
-list_documents_response_instance = ListDocumentsResponse.from_json(json)
-# print the JSON string representation of the object
-print(ListDocumentsResponse.to_json())
-
-# convert the object into a dict
-list_documents_response_dict = list_documents_response_instance.to_dict()
-# create an instance of ListDocumentsResponse from a dict
-list_documents_response_from_dict = ListDocumentsResponse.from_dict(list_documents_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/ListMemoryUnitsResponse.md

@@ -1,33 +0,0 @@
-# ListMemoryUnitsResponse
-
-Response model for list memory units endpoint.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | **List[Dict[str, object]]** |  | 
-**total** | **int** |  | 
-**limit** | **int** |  | 
-**offset** | **int** |  | 
-
-## Example
-
-```python
-from hindsight_client_api.models.list_memory_units_response import ListMemoryUnitsResponse
-
-# TODO update the JSON string below
-json = "{}"
-# create an instance of ListMemoryUnitsResponse from a JSON string
-list_memory_units_response_instance = ListMemoryUnitsResponse.from_json(json)
-# print the JSON string representation of the object
-print(ListMemoryUnitsResponse.to_json())
-
-# convert the object into a dict
-list_memory_units_response_dict = list_memory_units_response_instance.to_dict()
-# create an instance of ListMemoryUnitsResponse from a dict
-list_memory_units_response_from_dict = ListMemoryUnitsResponse.from_dict(list_memory_units_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)
-
-