Interface: RankingContext

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

Context for ranking operations.

Remarks

Provides user context and query for personalized ranking. Either userDid or userFields should be provided for personalization.

Properties

query?

readonly optional query: string

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

Search query for text relevance scoring.

---

sessionId?

readonly optional sessionId: string

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

Session ID for relevance logging.

---

userDid?

readonly optional userDid: string

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

User DID for looking up fields from profile/claims.

Remarks

If provided without userFields, the service will look up the user's research fields from their profile or claimed papers.

---

userFields?

readonly optional userFields: readonly string[]

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

Explicit user fields override.

Remarks

If provided, these fields are used instead of looking up from the database. Useful for testing or when fields are already known.