Skip to main content
DELETE
/
knowledge
/
{knowledge_base_id}
/
query
Python
from opperai import Opper

opper = Opper(http_bearer="YOUR_API_KEY")

# knowledge base ID
knowledge_base_id = "246ca533-e267-4374-8963-d8a4dd701b1d"

# delete documents based on filters
result = opper.knowledge.delete_documents(
    index_id=knowledge_base_id,
    filters=[
        {"field": "category", "operation": "=", "value": "outdated"},
        {"field": "version", "operation": "<", "value": 2},
    ],
)

print(f"deleted {result.deleted_count} documents")
{
  "deleted_count": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
knowledge_base_id
string<uuid>
required

The id of the knowledge base to delete or delete documents from

Body

application/json
​
filters
Filter · object[] | null

Filters to apply for deletion. If no filters are provided, the entire knowledge base will be deleted.

Example:
[
  {
    "field": "category",
    "operation": "=",
    "value": "outdated"
  },
  {
    "field": "version",
    "operation": "<",
    "value": 2
  }
]

Response

The number of documents deleted is returned

​
deleted_count
integer
required

The number of documents deleted

Example:

5