Skip to main content

Interface: SearchQuery

Defined in: src/types/interfaces/search.interface.ts:100

Search query parameters.

Extended by​

Properties​

filters?​

readonly optional filters: object

Defined in: src/types/interfaces/search.interface.ts:119

Filters to apply.

author?​

readonly optional author: DID

Filter by author DID.

dateFrom?​

readonly optional dateFrom: Date

Filter by creation date range (from).

dateTo?​

readonly optional dateTo: Date

Filter by creation date range (to).

subjects?​

readonly optional subjects: readonly string[]

Filter by subject classifications.

Remarks​

Filters are applied as boolean filters (not affecting scoring).

limit?​

readonly optional limit: number

Defined in: src/types/interfaces/search.interface.ts:147

Maximum number of results to return.

Remarks​

Default: 10. Maximum: 100.

offset?​

readonly optional offset: number

Defined in: src/types/interfaces/search.interface.ts:155

Offset for pagination.

Remarks​

For deep pagination, use search_after instead.

q​

readonly q: string

Defined in: src/types/interfaces/search.interface.ts:111

Query string.

Remarks​

Supports Elasticsearch query string syntax:

  • Simple: "neural networks"
  • Field-specific: "title:neural AND abstract:biology"
  • Wildcards: "neuro*"
  • Phrases: ""neural networks""

sort?​

readonly optional sort: "relevance" | "recent"

Defined in: src/types/interfaces/search.interface.ts:166

Sort order for results.

Remarks​

  • 'relevance': default Elasticsearch BM25 scoring
  • 'recent': sort by created_at descending (newest first)

Default Value​

'relevance'