deleteEntity()

deleteEntity(request: DeleteEntityRequest): Promise<EntityOperationResponse>

Defined in: packages/core/src/document-search/index.ts:753

Delete an entity from document chunks

Removes an entity from the document index. Can be scoped to specific sources, files, or chunks. Respects user permissions.

Parameters

Parameter	Type	Description
request	DeleteEntityRequest	Entity deletion request

Returns

Promise<EntityOperationResponse>

Promise resolving to EntityOperationResponse:

• success - Whether the operation succeeded
• affectedChunks - Number of chunks where entity was removed
• message - Success or error message

Throws

401 - Not authenticated

Throws

404 - Entity not found

Throws

422 - Validation error

Example

import { deleteEntity } from "@cpod/sdk";

// Delete entity globally
const result = await deleteEntity({ name: "Acme Corporation" });
console.log(`Deleted from ${result.affectedChunks} chunks`);

// Delete only from specific sources
const scopedResult = await deleteEntity({
  name: "Outdated Term",
  sources: ["legacy_docs"],
});

// Delete from specific file
const fileResult = await deleteEntity({
  name: "Typo Entity",
  fileHashes: ["95d47a820fcc0a667004a6da403b3d29"],
});