Class NspamClassifier

constructor

• new NspamClassifier(
      model: NspamModel,
      options?: NspamClassifierOptions,
  ): NspamClassifier

  Parameters

  • model: NspamModel
  • options: NspamClassifierOptions = {}

  Returns NspamClassifier

Readonlymodel

threshold

add

• add(event: NostrEvent): boolean

  Adds a reply to its author's bundle, returns false if the event is not a reply or did not change the bundle

  Parameters

  • event: NostrEvent

  Returns boolean

getScore

• getScore(pubkey: string): NspamScore | undefined

  Returns the score for an author's bundle, or undefined if no replies from them have been added

  Parameters

  • pubkey: string

  Returns NspamScore | undefined

isSpam

• isSpam(event: NostrEvent): boolean

  Adds a reply to its author's bundle and checks if the author scores at or above the threshold

  Parameters

  • event: NostrEvent

  Returns boolean

score

• score(events: NostrEvent[]): NspamScore

  Scores a bundle of replies from a single author without remembering them

  Parameters

  • events: NostrEvent[]

  Returns NspamScore

  Throws

  if there are no replies or they are from more than one author

Staticload

• load(
      options?: NspamClassifierOptions & { url?: string },
  ): Promise<NspamClassifier>

  Downloads the nspam model and creates a classifier

  Parameters

  • Optionaloptions: NspamClassifierOptions & { url?: string }

  Returns Promise<NspamClassifier>

  Throws

  if the model fails to download or parse