Skip to main content

AddEntityRequest

Defined in: packages/core/src/document-search/types.ts:253

Request to add a new entity

Properties

description?

optional description: string

Defined in: packages/core/src/document-search/types.ts:263

Entity description (optional)


entity

entity: string

Defined in: packages/core/src/document-search/types.ts:255

Entity name (required)


entityType

entityType: string

Defined in: packages/core/src/document-search/types.ts:261

Entity type (required) - e.g., "PERSON", "ORGANIZATION", "LOCATION", "PRODUCT"


id

id: string

Defined in: packages/core/src/document-search/types.ts:257

Chunk or file ID (required)


updateType?

optional updateType: "chunk" | "file"

Defined in: packages/core/src/document-search/types.ts:265

Update type: 'chunk' for single chunk, 'file' for all chunks (default: 'chunk')


userName

userName: string

Defined in: packages/core/src/document-search/types.ts:259

User name performing the operation (required)