Skip to main content

SearchRequest

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

Request parameters for document search

Properties

bypassPermissions?

optional bypassPermissions: boolean

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

Bypass source permission checks (admin only)


chunkIds?

optional chunkIds: string[] | null

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

Filter by specific chunk IDs


entities?

optional entities: string[] | null

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

Filter by entity names


fileHashes?

optional fileHashes: string[] | null

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

Filter by specific file hashes


includeContent?

optional includeContent: boolean

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

Include full content in results (default: true)


includeEntities?

optional includeEntities: boolean

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

Include entities in results (default: true)


limit?

optional limit: number

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

Maximum results to return (1-100, default: 10)


offset?

optional offset: number

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

Offset for pagination (default: 0)


query

query: string

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

Search query string (required)


sortBy?

optional sortBy: "relevance" | "date"

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

Sort order: "relevance" | "date" (default: "relevance")


sources?

optional sources: string[] | null

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

Filter by specific sources