78 lines
No EOL
3.8 KiB
Text
78 lines
No EOL
3.8 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: eJztVk1vGzcQ/SvE5JIYG8kxetqbGsupAacNYjUX2wjG3JGWMZfckLNyVGH/ezHkrj7iOkWBoqf64hU/3gzfzLyZLTCuIpQ3cO5115DjCHcFVBR1MC0b76CEc7LEpFBVwxmFrlJorTIcFcbotUGmSjXU+LBRnUvrrlLWuIc4uXW3blGbqB6NtUpj1FiRqhJqeeteq0VNe2zDkexSlmfWHkPSNw6oxdIy+EaxYI73xgvJpHrJ1LQ+oC1UpAYdG10ocmx48+rQ40fDteLaRzqytPPYtxRQaFAanfOs7kl1rvKOJlDAbveyghLygz6PDkEBLQZsiCkIw1tw2BCUgCty/NlUUIARelvkGgoI9LUzgSooOXRUQNQ1NQjlFnjTyr3IwbgVFMCGrSzMBEhdVtD3xQ59NP9vGBhzItu4E4jYehcpyq2z01P5d5wr153WFOOys+rjcBgK0N6xUFJuAdvWGp1Ym36Jcme796Tv+76An87OngJ/QmuqHIp5CD78A1Rog0SKTfa7IkZj5cswNfHpAev10S66zW/LFMFjooT1YcU4phUF6O/6YlzDEHBzwOaVzw5CX0ATVz8i/j3FiCuCHdjzRxMZaiG7/d62v/9Cmo+CfpPelU0P5+72MHt6M7vPP+M80/dXxsYjvywWH54A5tg2xLXfV0sqEq6hhCm2Zrp+M03VEafbsUr66ZjRcbo9SO4+ZffSJ26OCuJ9LuTZh0v4Xslu3UyNyvB6FIax8uMmMjVq6YOaXarsh+IaWUX2gWKhAnEwtJZPUbdAGL2Lyq8pZBBDWe1evFAXhNwFSlJyok5OfkbW9ejbNfuAKzo5KdMnqaazbFpLOxhFy6XRhhzbTVYp7Ng3KP4uUfOohcYP+Nfja64Jg64F+sIkJy2t0fEeuYvGrZQT99Aqi27V4YrU145kO6NdiAlJKnVhLJPkXHI2YSvUwceoHn2wVfJGCEncZ48GfnxrnPxSkUQJmewmoy9q4x7U3FWtN44F+B05kVJSqaa/cYdWoYuPFKK6x0iV8m4wYaqs48nE+KiM+y5gW6tPJnZozR8p+QT80jElrtY7lV+lk+vDkxliJ3mLgPpheHb6zvbQCVcDyi4zc4S6NlJgFbu29YGHPJgFXRsmLcmQ2wqNmdZFiqn/nZwshqRUV9K+xOZb7xzpg7ClTMRASltpV8YpNg3l67vgP7k+Jjlau1HRNMZiOGBNLs8znX9jWd4p4sviPzaUu+kO5LoNhJUk1kyIPuLeWpMixwHXFCLaVGMDh0NNob11avgbpB11kvahr42Vk6gTebJGk3SX/ZFZi7omdTY5hQK6YKGEmrmN5XT6+Pg4wbQ98WE1He7G6dXl2/mv1/PXZ5PTSc2NFWDxMcvFm8np5FSWWh+5QXdg68lM9L3WbPft6f8B6rkBamggUvHT1qJJvTFFbjv0hRvA1kAB6zdQ5MkpQgHlwQy1K0JZP5x+7gqofWTB2G5FRH4Ptu9lWaRuA+XNXQFrDAbvpXvcbKEyUb4rKJdoI/0goi8/Dn31lXruGWP7dNI812g7+QUFPNDmcAiUIeI/tHtIUBpWasKKQnp+PjHTmlo+uPtktpJJcNfHz+dX88Uc+v5PedtN5A==
|
|
sidebar_class_name: "delete api-method"
|
|
info_path: docs/api-reference/endpoints/agent-memory-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={"/api/v1/agents/{agent_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":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent 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>
|
|
|
|
|
|
|