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+Wh2Ciyw6GlPtinykXp8pFsoKCiva9bOQg53ZIhJoCicaiqyLNAWAo0RmoPAEJzSyFSIiirnD6KxyW4LYbR9DpMn+2QXpQ5ir40RCoPCgkSRUPMn+0YsSjphaw5kNtF8a8wlJP1gjypm2nhXCY6YY9wYkFKKV0xV7TwaKQJVaFkrKciy5sPr84r3mkvBpQt0kelYsavJY6RBKLTWsViTaGzhLE1AwvH0voAc+gt9HQsCCTV6rIjJB8iXLVisCHJYo33+qguQoCO7NXIJEjx9b7SnAnL2DUkIqqQKIW+BD3UMC+y13YIE1myi4Q+0z+K+gK6TR+wx+X+Bfzd2JOVYRYhQOxsoxKjZdBofl0p5bJSiEDaNEZ8GZ5CgnOVISN4C1rXRKnGWfQsxpj1V0nVdJ+HtbHYN/AWNLvpGzL13/l+gQu1jn1j3dRfEqE1800xVuHYwTl2coj182KT+XRIVWR8s2jJtyUO36uRoQ+/xcMbmg+sLhE5CFba/Iv49hYBbgiPYy66JDLGIp90pt1t/I8UXTV+me/WpB7/VCeZEb8/uy9e46+n7p2Sjy7vF4uMVYN/birh0p1lJI8Il5JDtbrKCNtgYzuJ8hKwdxqTLRk2HrD2Td5f0vXGJnTGztkXQ25JFrEHcfrwH+ZOQxgOxcV4c/Qc5oUpyGmbpfb8QHg+BqYqUGK0oKvrkclujKknMJlOQ0HgDOZTMdcizbL/fTzAdT5zfZkNsyB7u/5z/9Th/M5tMJyVXJgLvyIe+vJvJdDKNptoFrtCe5brawj/frT2NxP8r+6WVPYiW6QdntUGd5jF1rh20uITdTaI2qRFk2tcBJOSnxX2UZDSf79yVhNIFjihtu8ZAn73pumj+3pA/QL5cSdih17iOil22UOgQ3wvIN2gC/aKnrz4N0/xavHSRcWhtHNkdmiZ+gYRnOpz9eOLm+o1pz/lJG7IkLMin2/cet0pRzWexVws9/n6Oy+Nu/jBfzKHr/gaan/5N
|
|
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>
|
|
|
|
|
|
|