Skip to main content

Interface: RankableItem

Defined in: src/types/interfaces/ranking.interface.ts:115

Base interface for items that can be ranked.

Remarks

All items to be ranked must have at least a title. Categories, authors, source, and publication date are optional but improve ranking accuracy.

Extended by

Properties

abstract?

readonly optional abstract: string

Defined in: src/types/interfaces/ranking.interface.ts:140

Abstract text for extended matching.


authors?

readonly optional authors: readonly object[]

Defined in: src/types/interfaces/ranking.interface.ts:135

Authors of the item.


categories?

readonly optional categories: readonly string[]

Defined in: src/types/interfaces/ranking.interface.ts:130

Categories or fields associated with the item.

Remarks

Used for field relevance scoring. Can be:

  • arXiv categories (e.g., "cs.AI", "physics.hep-th")
  • Field names (e.g., "Computer Science", "Physics")
  • Subject headings

publicationDate?

readonly optional publicationDate: Date

Defined in: src/types/interfaces/ranking.interface.ts:150

Publication date.


source?

readonly optional source: string

Defined in: src/types/interfaces/ranking.interface.ts:145

Source identifier (e.g., "arxiv", "lingbuzz").


title

readonly title: string

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

Item title (required for text matching).