hindsight-client 0.0.13__py3-none-any.whl

hindsight_client_api/docs/DeleteResponse.md

@@ -0,0 +1,30 @@
+# DeleteResponse
+
+Response model for delete operations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** |  | 
+
+## Example
+
+```python
+from hindsight_client_api.models.delete_response import DeleteResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DeleteResponse from a JSON string
+delete_response_instance = DeleteResponse.from_json(json)
+# print the JSON string representation of the object
+print(DeleteResponse.to_json())
+
+# convert the object into a dict
+delete_response_dict = delete_response_instance.to_dict()
+# create an instance of DeleteResponse from a dict
+delete_response_from_dict = DeleteResponse.from_dict(delete_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/DocumentResponse.md

@@ -0,0 +1,36 @@
+# DocumentResponse
+
+Response model for get document endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**bank_id** | **str** |  | 
+**original_text** | **str** |  | 
+**content_hash** | **str** |  | 
+**created_at** | **str** |  | 
+**updated_at** | **str** |  | 
+**memory_unit_count** | **int** |  | 
+
+## Example
+
+```python
+from hindsight_client_api.models.document_response import DocumentResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DocumentResponse from a JSON string
+document_response_instance = DocumentResponse.from_json(json)
+# print the JSON string representation of the object
+print(DocumentResponse.to_json())
+
+# convert the object into a dict
+document_response_dict = document_response_instance.to_dict()
+# create an instance of DocumentResponse from a dict
+document_response_from_dict = DocumentResponse.from_dict(document_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/EntityDetailResponse.md

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,30 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,30 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,33 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,33 @@
+# 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

@@ -0,0 +1,33 @@
+# 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)
+
+

hindsight_client_api/docs/MemoryItem.md

@@ -0,0 +1,34 @@
+# MemoryItem
+
+Single memory item for retain.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **str** |  | 
+**timestamp** | **datetime** |  | [optional] 
+**context** | **str** |  | [optional] 
+**metadata** | **Dict[str, str]** |  | [optional] 
+**document_id** | **str** |  | [optional] 
+
+## Example
+
+```python
+from hindsight_client_api.models.memory_item import MemoryItem
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MemoryItem from a JSON string
+memory_item_instance = MemoryItem.from_json(json)
+# print the JSON string representation of the object
+print(MemoryItem.to_json())
+
+# convert the object into a dict
+memory_item_dict = memory_item_instance.to_dict()
+# create an instance of MemoryItem from a dict
+memory_item_from_dict = MemoryItem.from_dict(memory_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/MetadataFilter.md

@@ -0,0 +1,32 @@
+# MetadataFilter
+
+Filter for metadata fields. Matches records where (key=value) OR (key not set) when match_unset=True.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Metadata key to filter on | 
+**value** | **str** |  | [optional] 
+**match_unset** | **bool** | If True, also match records where this metadata key is not set | [optional] [default to True]
+
+## Example
+
+```python
+from hindsight_client_api.models.metadata_filter import MetadataFilter
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MetadataFilter from a JSON string
+metadata_filter_instance = MetadataFilter.from_json(json)
+# print the JSON string representation of the object
+print(MetadataFilter.to_json())
+
+# convert the object into a dict
+metadata_filter_dict = metadata_filter_instance.to_dict()
+# create an instance of MetadataFilter from a dict
+metadata_filter_from_dict = MetadataFilter.from_dict(metadata_filter_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/MonitoringApi.md

@@ -0,0 +1,72 @@
+# hindsight_client_api.MonitoringApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**metrics_endpoint_metrics_get**](MonitoringApi.md#metrics_endpoint_metrics_get) | **GET** /metrics | Prometheus metrics endpoint
+
+
+# **metrics_endpoint_metrics_get**
+> object metrics_endpoint_metrics_get()
+
+Prometheus metrics endpoint
+
+Exports metrics in Prometheus format for scraping
+
+### Example
+
+
+```python
+import hindsight_client_api
+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.MonitoringApi(api_client)
+
+    try:
+        # Prometheus metrics endpoint
+        api_response = await api_instance.metrics_endpoint_metrics_get()
+        print("The response of MonitoringApi->metrics_endpoint_metrics_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling MonitoringApi->metrics_endpoint_metrics_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**object**
+
+### 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 |  -  |
+
+[[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/PersonalityTraits.md

@@ -0,0 +1,35 @@
+# PersonalityTraits
+
+Personality traits based on Big Five model.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**openness** | **float** | Openness to experience (0-1) | 
+**conscientiousness** | **float** | Conscientiousness (0-1) | 
+**extraversion** | **float** | Extraversion (0-1) | 
+**agreeableness** | **float** | Agreeableness (0-1) | 
+**neuroticism** | **float** | Neuroticism (0-1) | 
+**bias_strength** | **float** | How strongly personality influences opinions (0-1) | 
+
+## Example
+
+```python
+from hindsight_client_api.models.personality_traits import PersonalityTraits
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PersonalityTraits from a JSON string
+personality_traits_instance = PersonalityTraits.from_json(json)
+# print the JSON string representation of the object
+print(PersonalityTraits.to_json())
+
+# convert the object into a dict
+personality_traits_dict = personality_traits_instance.to_dict()
+# create an instance of PersonalityTraits from a dict
+personality_traits_from_dict = PersonalityTraits.from_dict(personality_traits_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

@@ -0,0 +1,37 @@
+# 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] 
+**filters** | [**List[MetadataFilter]**](MetadataFilter.md) |  | [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

@@ -0,0 +1,33 @@
+# 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)
+
+