hindsight-client 0.0.13__py3-none-any.whl

hindsight_client_api/docs/RecallResult.md

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

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

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

@@ -0,0 +1,34 @@
+# ReflectRequest
+
+Request model for reflect endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **str** |  | 
+**budget** | [**Budget**](Budget.md) |  | [optional] 
+**context** | **str** |  | [optional] 
+**filters** | [**List[MetadataFilter]**](MetadataFilter.md) |  | [optional] 
+**include** | [**ReflectIncludeOptions**](ReflectIncludeOptions.md) | Options for including additional data (disabled by default) | [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

@@ -0,0 +1,31 @@
+# ReflectResponse
+
+Response model for think endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **str** |  | 
+**based_on** | [**List[ReflectFact]**](ReflectFact.md) |  | [optional] [default to []]
+
+## 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

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

@@ -0,0 +1,33 @@
+# 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/UpdatePersonalityRequest.md

@@ -0,0 +1,30 @@
+# UpdatePersonalityRequest
+
+Request model for updating personality traits.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personality** | [**PersonalityTraits**](PersonalityTraits.md) |  | 
+
+## Example
+
+```python
+from hindsight_client_api.models.update_personality_request import UpdatePersonalityRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UpdatePersonalityRequest from a JSON string
+update_personality_request_instance = UpdatePersonalityRequest.from_json(json)
+# print the JSON string representation of the object
+print(UpdatePersonalityRequest.to_json())
+
+# convert the object into a dict
+update_personality_request_dict = update_personality_request_instance.to_dict()
+# create an instance of UpdatePersonalityRequest from a dict
+update_personality_request_from_dict = UpdatePersonalityRequest.from_dict(update_personality_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

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

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

hindsight_client_api/exceptions.py

@@ -0,0 +1,219 @@
+# coding: utf-8
+
+"""
+    Hindsight HTTP API
+
+    HTTP API for Hindsight
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

hindsight_client_api/models/__init__.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    Hindsight HTTP API
+
+    HTTP API for Hindsight
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from hindsight_client_api.models.add_background_request import AddBackgroundRequest
+from hindsight_client_api.models.background_response import BackgroundResponse
+from hindsight_client_api.models.bank_list_item import BankListItem
+from hindsight_client_api.models.bank_list_response import BankListResponse
+from hindsight_client_api.models.bank_profile_response import BankProfileResponse
+from hindsight_client_api.models.budget import Budget
+from hindsight_client_api.models.chunk_data import ChunkData
+from hindsight_client_api.models.chunk_include_options import ChunkIncludeOptions
+from hindsight_client_api.models.chunk_response import ChunkResponse
+from hindsight_client_api.models.create_bank_request import CreateBankRequest
+from hindsight_client_api.models.delete_response import DeleteResponse
+from hindsight_client_api.models.document_response import DocumentResponse
+from hindsight_client_api.models.entity_detail_response import EntityDetailResponse
+from hindsight_client_api.models.entity_include_options import EntityIncludeOptions
+from hindsight_client_api.models.entity_list_item import EntityListItem
+from hindsight_client_api.models.entity_list_response import EntityListResponse
+from hindsight_client_api.models.entity_observation_response import EntityObservationResponse
+from hindsight_client_api.models.entity_state_response import EntityStateResponse
+from hindsight_client_api.models.graph_data_response import GraphDataResponse
+from hindsight_client_api.models.http_validation_error import HTTPValidationError
+from hindsight_client_api.models.include_options import IncludeOptions
+from hindsight_client_api.models.list_documents_response import ListDocumentsResponse
+from hindsight_client_api.models.list_memory_units_response import ListMemoryUnitsResponse
+from hindsight_client_api.models.memory_item import MemoryItem
+from hindsight_client_api.models.metadata_filter import MetadataFilter
+from hindsight_client_api.models.personality_traits import PersonalityTraits
+from hindsight_client_api.models.recall_request import RecallRequest
+from hindsight_client_api.models.recall_response import RecallResponse
+from hindsight_client_api.models.recall_result import RecallResult
+from hindsight_client_api.models.reflect_fact import ReflectFact
+from hindsight_client_api.models.reflect_include_options import ReflectIncludeOptions
+from hindsight_client_api.models.reflect_request import ReflectRequest
+from hindsight_client_api.models.reflect_response import ReflectResponse
+from hindsight_client_api.models.retain_request import RetainRequest
+from hindsight_client_api.models.retain_response import RetainResponse
+from hindsight_client_api.models.update_personality_request import UpdatePersonalityRequest
+from hindsight_client_api.models.validation_error import ValidationError
+from hindsight_client_api.models.validation_error_loc_inner import ValidationErrorLocInner
+