Skip to main content

SearchResponse

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

Search response

Properties​

entities?​

optional entities: string[] | null

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

Entities that were filtered

limit​

limit: number

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

Limit used

offset​

offset: number

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

Offset used

query​

query: string

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

Original query

results​

results: SearchResult[]

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

Array of search results

sources?​

optional sources: string[] | null

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

Sources that were searched

tookMs?​

optional tookMs: number | null

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

Query execution time in milliseconds

total​

total: number

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

Total number of matching documents