78 lines
No EOL
3.3 KiB
Text
78 lines
No EOL
3.3 KiB
Text
---
|
|
id: delete-document
|
|
title: "Delete a document"
|
|
description: "Delete a document and all its associated memory units and links."
|
|
sidebar_label: "Delete a document"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztVU2P2zgM/SsCTy2gxpmgJ99mdwJ0gOm26KS9ZIKCkZlYHVlyJTppYPi/LyTb+Wh2Ciyw6GlPtinykXp8pFtg3AbIl3DnVFOR5QArCQUF5XXN2lnI4Y4MMQkUxeAj0BYCjRGag8AQnNLIVIiKKucPorHJbgthtH0Okyf7ZBelDmKvjREKg8KCRJFQ8yf7RixKOmFrDmQ20XxrzCUk/WCPKmbaeFcJjphj3BiQUopXTFXtPBopAlVoWSspyLLmw+vziveaS8GlC3SR6Vixq8ljpEEotNaxWJNobOEsTUDC8fS+gBz6C30dCwIJNXqsiMlHhluwWBHksEb7/FUXIEFHdmvkEiR4+t5oTwXk7BuSEFRJFULeAh/qGBbYa7sFCazZRMMfaJ/FfQFdJ4/YY/L/An9URJ9jFSFC7WygEKNm02l8XCrlsVGKQtg0RnwanEGCcpYjIXkLWNdGq8RZ9i3EmPZUSdd1nYS3s9k18Bc0uugbMffe+X+BCrWPfWLd110QozbxTTNV4drBOHVxivbwYZP6d0lUZH2waMu0JQ/dqpOjDb3HwxmbD64vEDoJVdj+ivj3FAJuCY5gL7smMsQinnan3G79jRRfNH2Z7tWnHvxWJ5gTvT27L1/jrqfvn5KNLu8Wi49XgH1vK+LSnWYljQiXkEO2u8kK2mBjOIvzEbJ2GJMuGzUdsvZM3l3S98YldsbM2hZBb0sWsQZx+/Eeft5l44HYOC+O/oOcUCU5DbP0vl8Ij4fAVEVKjFYUFX1yua1RlSRmkylIaLyBHErmOuRZtt/vJ5iOJ85vsyE2ZA/3f87/epy/mU2mk5IrE4F35ENf3s1kOplGU+0CV2jPcl1t4Z/v1p5G4v+V/dLKHkTL9IOz2qBO85g61w5aXMLuJlGb1Agy7esAEvLT4j5KMprPd+5KQukCR5S2XWOgz950XTR/b8gfIF+uJOzQa1xHxS5bKHSI7wXkGzSBftHTV5+GaX4tXrrIOLQ2juwOTRO/QMIzHc5+PHFz/ca05/ykDVkSFuTT7XuPW6Wo5rPYq4Uefz/H5XE3f5gv5tB1fwPJKQVj
|
|
sidebar_class_name: "delete api-method"
|
|
info_path: docs/api-reference/endpoints/hindsight-http-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Delete a document"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"delete"}
|
|
path={"/v1/default/banks/{bank_id}/documents/{document_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
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.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|