Skip to content

Latest commit

 

History

History
234 lines (198 loc) · 9.37 KB

README.md

File metadata and controls

234 lines (198 loc) · 9.37 KB
Raw

nostr-monitoring-tool

A simple monitoring tool that classify nostr events (SFW/NSFW, language, topic, sentiment, toxic comment, etc).

A core module of atrifat/nostr-filter-relay.

Features

It will classify note events (kind: 1) content in various category such as:

Requirements

Getting Started

You can start by cloning this repository to run or modify it locally

git clone https://github.com/atrifat/nostr-monitoring-tool
cd nostr-monitoring-tool

install its dependencies

npm install

Before running this tool, make sure you have already run your own atrifat/nsfw-detector-api, atrifat/language-detector-api or LibreTranslate, atrifat/hate-speech-detector-api, atrifat/sentiment-analysis-api, and atrifat/topic-classification-api instance since it is required for content classification. You don't have to run all of them only if you enable classification for certain task (Example: NSFW detection task only).

Copy .env.example into .env and change .env value properly

cp .env.example .env

Now, you can run this tool using command

npm run start

or run it using node command directly

node src/index.mjs

This tool will classify note events and publish classification result as NIP-32 event (kind: 1985) or legacy custom event (kind: 9978).

  • For NSFW classification, it will publish NIP-32 event using 'L' tag with namespace 'app.nfrelay.content-safety' or legacy classification event using 'd' tag with 'nostr-nsfw-classification'.
  • For language detection, it will publish NIP-32 event using 'L' tag with namespace 'app.nfrelay.language' or legacy classification event using 'd' tag with 'nostr-language-classification'.
  • For hate speech detection, it will publish NIP-32 event using 'L' tag with namespace 'app.nfrelay.toxicity' or legacy classification event using 'd' tag with 'nostr-hate-speech-classification'.
  • For sentiment analysis, it will publish NIP-32 event using 'L' tag with namespace 'app.nfrelay.sentiment' or legacy classification event using 'd' tag with 'nostr-sentiment-classification'.
  • For topic classification, it will publish NIP-32 event using 'L' tag with namespace 'app.nfrelay.topic' or legacy classification event using 'd' tag with 'nostr-topic-classification'.

Classification event format (NIP-32 format or legacy format) can be set using .env or environment variable

# (Optional. Default: true) Set whether to publish NIP-32 classification event (kind: 1985)
ENABLE_NIP_32_CLASSIFICATION_EVENT=true
# (Optional. Default: true) (Deprecated) Set whether to publish legacy classification event (kind: 9978)
ENABLE_LEGACY_CLASSIFICATION_EVENT=true

Classification events can be used in another tool such as nostr-filter-relay to filter note events. Classification event with NIP-32 event structure was documented in NIP32-COMPATIBILITY.md.

Classification Event (NIP-32) Example:

{
  "kind": 1985,
  "id": "eventId",
  "pubkey": "pubkey",
  "created_at": 1724725335,
  "tags": [
    [
      "e",
      "b607571328e99aa08121636251df8148a60fdf534276bf80ffd4da1fa406ee31",
      "wss://nfrelay.app"
    ],
    [
      "p",
      "aa51d51cc0768483545fe5a51658bd2f099bd1242baa2a15b3077075917725a5"
    ],
    [
      "L",
      "app.nfrelay.content-safety"
    ],
    [
      "label_score_type",
      "app.nfrelay.content-safety",
      "float"
    ],
    [
      "label_model",
      "app.nfrelay.content-safety",
      "atrifat/nsfw-detector-api",
      "https://github.com/atrifat/nsfw-detector-api"
    ],
    [
      "label_minimum_score",
      "app.nfrelay.content-safety",
      "0.5"
    ],
    [
      "label_schema",
      "app.nfrelay.content-safety",
      "sfw",
      "nsfw"
    ],
    [
      "label_schema_original",
      "app.nfrelay.content-safety",
      "hentai",
      "neutral",
      "pornography",
      "sexy"
    ],
    [
      "l",
      "sfw",
      "app.nfrelay.content-safety"
    ],
    [
      "label_score",
      "sfw",
      "app.nfrelay.content-safety",
      "0.9987854361534119",
      "https://cdn.fosstodon.org/media_attachments/files/113/031/582/181/280/287/original/345a5e31646fd15f.jpg"
    ],
    [
      "label_score",
      "hentai",
      "app.nfrelay.content-safety",
      "0.0000033156150038848864",
      "https://cdn.fosstodon.org/media_attachments/files/113/031/582/181/280/287/original/345a5e31646fd15f.jpg"
    ],
    [
      "label_score",
      "neutral",
      "app.nfrelay.content-safety",
      "0.9987854361534119",
      "https://cdn.fosstodon.org/media_attachments/files/113/031/582/181/280/287/original/345a5e31646fd15f.jpg"
    ],
    [
      "label_score",
      "pornography",
      "app.nfrelay.content-safety",
      "0.0010158189106732607",
      "https://cdn.fosstodon.org/media_attachments/files/113/031/582/181/280/287/original/345a5e31646fd15f.jpg"
    ],
    [
      "label_score",
      "sexy",
      "app.nfrelay.content-safety",
      "0.00019537744810804725",
      "https://cdn.fosstodon.org/media_attachments/files/113/031/582/181/280/287/original/345a5e31646fd15f.jpg"
    ]
  ],
  "content": "",
  "sig": "signature"
}

Legacy Classification Event Example:

{
    "id": "eventId",
    "created_at": 1696817846,
    "kind": 9978,
    "pubkey": "pubkey",
    "sig": "signature",
    "content": "[{\"id\":\"58bd02d8c46eaa6f1598d5eff7cb33c06ff57c4c9ad3dad32ae2b70d3258f661\",\"author\":\"5fd004926969381ac2bb3a32720036d9f9632d29fb22dc1bf5d8fb1c9e265798\",\"is_activitypub_user\":false,\"has_content_warning\":false,\"has_nsfw_hashtag\":false,\"probably_nsfw\":false,\"high_probably_nsfw\":false,\"responsible_nsfw\":true,\"data\":{\"hentai\":0.0000018745902252703672,\"neutral\":0.9998550415039062,\"pornography\":0.0000746770019759424,\"sexy\":0.00006828152254456654,\"predictedLabel\":\"neutral\"},\"url\":\"https://image.nostr.build/b54386359e8ae33e261f29802ae690afc11f93096d9366c3317dd619f5d55c4a.jpg\"}]",
    "tags": [
        [
            "d",
            "nostr-nsfw-classification"
        ],
        [
            "t",
            "nostr-nsfw-classification"
        ],
        [
            "e",
            "58bd02d8c46eaa6f1598d5eff7cb33c06ff57c4c9ad3dad32ae2b70d3258f661"
        ],
        [
            "p",
            "5fd004926969381ac2bb3a32720036d9f9632d29fb22dc1bf5d8fb1c9e265798"
        ]
    ]
}

License

MIT License

Copyright (c) 2023 Rif'at Ahdi Ramadhani

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Rif'at Ahdi Ramadhani (atrifat)