fleet-memory/hindsight-clients/python/hindsight_client_api/docs/DocumentsApi.md

hindsight_client_api.DocumentsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
delete_document	DELETE /v1/default/banks/{bank_id}/documents/{document_id}	Delete a document
get_chunk	GET /v1/default/chunks/{chunk_id}	Get chunk details
get_document	GET /v1/default/banks/{bank_id}/documents/{document_id}	Get document details
list_documents	GET /v1/default/banks/{bank_id}/documents	List documents

delete_document

DeleteDocumentResponse delete_document(bank_id, document_id, authorization=authorization)

Delete a document

Delete a document and all its associated memory units and links.

This will cascade delete:

• The document itself
• All memory units extracted from this document
• All links (temporal, semantic, entity) associated with those memory units

This operation cannot be undone.

Example

import hindsight_client_api
from hindsight_client_api.models.delete_document_response import DeleteDocumentResponse
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.DocumentsApi(api_client)
    bank_id = 'bank_id_example' # str | 
    document_id = 'document_id_example' # str | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Delete a document
        api_response = await api_instance.delete_document(bank_id, document_id, authorization=authorization)
        print("The response of DocumentsApi->delete_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->delete_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str
document_id	str
authorization	str		[optional]

Return type

DeleteDocumentResponse

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] [Back to Model list] [Back to README]

get_chunk

ChunkResponse get_chunk(chunk_id, authorization=authorization)

Get chunk details

Get a specific chunk by its ID

Example

import hindsight_client_api
from hindsight_client_api.models.chunk_response import ChunkResponse
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.DocumentsApi(api_client)
    chunk_id = 'chunk_id_example' # str | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Get chunk details
        api_response = await api_instance.get_chunk(chunk_id, authorization=authorization)
        print("The response of DocumentsApi->get_chunk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_chunk: %s\n" % e)

Parameters

Name	Type	Description	Notes
chunk_id	str
authorization	str		[optional]

Return type

ChunkResponse

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] [Back to Model list] [Back to README]

get_document

DocumentResponse get_document(bank_id, document_id, authorization=authorization)

Get document details

Get a specific document including its original text

Example

import hindsight_client_api
from hindsight_client_api.models.document_response import DocumentResponse
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.DocumentsApi(api_client)
    bank_id = 'bank_id_example' # str | 
    document_id = 'document_id_example' # str | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # Get document details
        api_response = await api_instance.get_document(bank_id, document_id, authorization=authorization)
        print("The response of DocumentsApi->get_document:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->get_document: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str
document_id	str
authorization	str		[optional]

Return type

DocumentResponse

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] [Back to Model list] [Back to README]

list_documents

ListDocumentsResponse list_documents(bank_id, q=q, limit=limit, offset=offset, authorization=authorization)

List documents

List documents with pagination and optional search. Documents are the source content from which memory units are extracted.

Example

import hindsight_client_api
from hindsight_client_api.models.list_documents_response import ListDocumentsResponse
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.DocumentsApi(api_client)
    bank_id = 'bank_id_example' # str | 
    q = 'q_example' # str |  (optional)
    limit = 100 # int |  (optional) (default to 100)
    offset = 0 # int |  (optional) (default to 0)
    authorization = 'authorization_example' # str |  (optional)

    try:
        # List documents
        api_response = await api_instance.list_documents(bank_id, q=q, limit=limit, offset=offset, authorization=authorization)
        print("The response of DocumentsApi->list_documents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentsApi->list_documents: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str
q	str		[optional]
limit	int		[optional] [default to 100]
offset	int		[optional] [default to 0]
authorization	str		[optional]

Return type

ListDocumentsResponse

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] [Back to Model list] [Back to README]