Text

nima allows you to automatically detect harmful text using powerful ai detection providers example payload { "channel" "automated detection", "reason for request" "lorem abuse reason for request", "content" { "content id" "450100000tete", "title" "offensive content that matches with a bullying situation", "body" "lorem ipsum is simply dummy text of the printing and typesetting industry lorem ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book ", "rawtext" "hello, fat weirdo ", "language" "en", "token" "", "type" { "id" "txt" }, "status" "published", "customerspecific" { "boolean attribute" "true" } }, "reportee" { "id" "40644", "name" "reportee luke", "phonenumber" "070 504143", "emailaddress" "example\@gmail com", "customerspecific" { "boolean test" "true" } }, "location" { "city" "stockholm", "postalcode" "111 57", "region" "stockholm", "countrycode" "se", "ipaddress" "192 168 0 1", "customerspecific" {} } } request payload requirements for text moderation, ensure your request payload includes the following content type specific requirements true 314,314,315 left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type nima acts as a central hub and demultiplexer for all your proactive detection needs, providing single point connectivity to a wide range of third party ai detection providers by utilizing nima for integration, you eliminate the need to develop multiple, complex api integrations and future proof your trust & safety operations upon sending an item to nima, the platform efficiently relays it to the specific ai detection provider(s) of your choice and facilitates automated actions based on the received responses supported content types nima supports proactive detection for the following content types click on each type for detailed implementation guides docid\ fm6yrxolw76sv39vrnuh9 docid\ gtnrroo9oo b8utlom3a4 docid\ pcdyktouo36ksedccdhwq docid\ kmjfkvvy ejtwtb0afeos docid\ kva42 yagjoanlqznramw docid\ vrfdpi7e4p3 1mldyqb13 setting up proactive detection prerequisites to utilize ai detection in your workflows, the following must be in place the desired ai detection provider(s) must be configured in the ai marketplace with valid credentials you must have defined policies and moderation queues to be used for automated enforcement the primary endpoint to submit cases for proactive detection is queues/process file proactive detection is enabled through the rule engine navigate to admin settings > workflow configuration to set up a rule and ensure your payloads will be received in nima conditions to route any case to an ai detection provider, the rule must contain these two mandatory conditions channel must be set to "proactive detection" content type must be set to the type of content being submitted (e g , "text", "image", "video", "audio", or "video stream") once these are set, the list of available ai detection providers for that content type will be accessible via the choose provider button it is possible to configure multiple models (up to 3 models) per rule using the and and or operators if it is the case, multiple models will be displayed in the moderation console, api response, and backend for content type specific implementation details and requirements, refer to the content specific pages of the documentation how thresholds and actions work when a case is processed by an ai detection provider, the provider returns a confidence score nima uses your pre configured thresholds to determine the final action 🔴 red threshold if the confidence score falls within this range, the pre defined moderation action (e g , removal, suspension) will be immediately and automatically invoked 🟠 orange threshold the case will be redirected to a specific moderation queue for manual review 🟢 green threshold the case will be processed out of the system and not actioned sending requests request payloads the structure of the request payload made to queues/process file is very similar to that for user reports, with one difference the channel must equal "automated detection" global parameters true 235,235,235,238 left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type content true 235,235,235,238 left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type reportee true 235,235,235,238 left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type location the location attribute is not essential and any one of the following attributes may be passed in true 235,235,235,238 left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type a note on customerspecific attributes the global, content, reportee and reporter attributes all possess an optional field which accepts an object customerspecific key value pairs will always be accepted; however, to observe these customerspecific attributes in the metadata on the moderation dashboard, the client must configure these custom attributes in the "admin settings > custom attributes" configuration page more info on docid 2fmg8gdwrlps9p7lslnuf response upon processing, the api responds with a flagdata attribute this attribute mirrors the input json payload but is decorated with additional data retrieved from the ai detection provider the global customerspecific attribute will contain the raw data retrieved from the ai detection provider { "shouldqueueflagcreate" true, "flagdata" { "channel" "automated detection", "reason for request" "content moderated using ai", "customerspecific" { "summary" { "id" "0cbab320 a50f 11f0 863a 3390509fdd90", "code" 200, "project id" 1109668119, "user id" 4762, "created on" "2025 10 09t12 54 11 518z", "status" \[ { "status" { "code" "0", "message" "success" }, "response" { "input" { "charge" 0 00001, "created on" "2025 10 09t12 54 10 514z", "model" "mod64 4 new dense extra ens", "id" "0cbab320 a50f 11f0 863a 3390509fdd90", "media" { "url" null, "filename" null, "type" "photo", "mime type" "jpeg", "mimetype" "image/jpeg", "width" 400, "height" 400, "num frames" 1, "duration" 0 }, "model version" 1, "model type" "classification", "user id" 4762, "project id" 1109668119, "config version" 1, "config tag" "default" }, "output" \[ { "time" 0, "classes" \[ { "score" 1, "class" "general not nsfw not suggestive" }, { "score" 9 44821110238081e 10, "class" "general nsfw" }, { "score" 3 1891640439596362e 9, "class" "general suggestive" }, { "score" 1, "class" "no female underwear" }, { "score" 4 775388418032378e 10, "class" "yes female underwear" }, { "score" 1, "class" "no male underwear" }, { "score" 6 144879605152197e 10, "class" "yes male underwear" }, { "score" 1, "class" "no sex toy" }, { "score" 1 682822992066235e 9, "class" "yes sex toy" }, { "score" 1, "class" "no female nudity" }, { "score" 3 7282382736592007e 10, "class" "yes female nudity" }, { "score" 1, "class" "no male nudity" }, { "score" 4 351427662641072e 9, "class" "yes male nudity" }, { "score" 1, "class" "no female swimwear" }, { "score" 8 637842524583661e 11, "class" "yes female swimwear" }, { "score" 1, "class" "no male shirtless" }, { "score" 6 832969190462278e 10, "class" "yes male shirtless" }, { "score" 0 9990317821502686, "class" "no text" }, { "score" 0 0009682858944870532, "class" "text" }, { "score" 0 00004784707925864495, "class" "animated" }, { "score" 0 0000030272485673776828, "class" "hybrid" }, { "score" 0 9999492168426514, "class" "natural" }, { "score" 1 5425227761767244e 9, "class" "animated gun" }, { "score" 3 8822928871695694e 8, "class" "gun in hand" }, { "score" 6 655429984903094e 8, "class" "gun not in hand" }, { "score" 0 9999998807907104, "class" "no gun" }, { "score" 6 558474874296394e 10, "class" "culinary knife in hand" }, { "score" 1 5358057936509795e 8, "class" "culinary knife not in hand" }, { "score" 3 359654110468568e 9, "class" "knife in hand" }, { "score" 8 217730282922275e 7, "class" "knife not in hand" }, { "score" 0 9999991655349731, "class" "no knife" }, { "score" 9 284041313506464e 10, "class" "a little bloody" }, { "score" 1, "class" "no blood" }, { "score" 8 553271868549928e 9, "class" "other blood" }, { "score" 6 558339982198902e 11, "class" "very bloody" }, { "score" 1, "class" "no fight" }, { "score" 3 38575834035737e 11, "class" "yes fight" } / truncated for brevity / ] } ] } } ], "from cache" false, "hsl options" {} }, "probs" { "general not nsfw not suggestive" 1, "general nsfw" 0, "general suggestive" 0, "no female underwear" 1, "yes female underwear" 0 / truncated for brevity / }, "detectedby" "hive", "outcome" { "status" "green", "matchedrule" null } }, "content" { "content id" "f747c6ad 7771 4be6 a4e0 8ffbf7c4401c", "title" "profile pic", "body" "profile pic", "url" "https //picsum photos/400/400", "type" { "id" "img" }, "customerspecific" { "platform content type" "profile picture" } }, "reportee" { "id" "12345", "name" "test user", "lang" "en us", "phonenumber" "+1234567890", "emailaddress" "placeholder 12345\@tremau fr", "customerspecific" { "reportee player level" "vip" } } }, "message" "success", "ok" true } if any configured rule is matched in the system, the payload will bear an outcome json node "outcome" { "status" "green", "matchedrule" null } if the status is green, then the case will not appear on the moderation console if the status is orange or red, then the corresponding rule will appear in the json response, and the corresponding case will be visible in queues for orange and in the report list for red the flagdata attribute reflects the input json payload with the following decorations the global customerspecific attribute will contain the data retrieved from the ai detection provider note proactive detection features are only available if the credentials for the ai detection providers have been provided in the configuration mapping content types to ai detection providers nima ensures that the correct ai detection provider is used for the correct content type the input request payload must have a content type that matches the content type supported by the provider configured in the rule (e g , if you set up a rule using a text only ai detection provider, the payload must specify content type "txt" ) note for emoji moderation, use content type "txt" as emojis are processed as text see docid\ kva42 yagjoanlqznramw for details configuring detection rules to create a rule for automated text detection, navigate to admin settings > workflow configuration and define the following conditions required conditions channel must be set to "proactive detection" content type must be set to "text" once these conditions are set, the list of available ai detection providers will be accessible via the choose provider button language support for optimal speed and accuracy, nima allows you to specify the expected language(s) of the content being sent for detection specifying languages you can pass a comma separated list of language codes (e g , lang=en,fr,es ) this should be included in the customerspecific node at the root level of the json payload sent to the api endpoint recommendation we strongly recommend specifying the shortest possible list of languages your users are likely to use, as this yields better results in both speed and accuracy if your users are predominantly english speakers, specifying only en will be most effective other languages are available upon request please contact support regarding your specific language needs