[civitai] add 'nsfw' option (#3706)

2024-09-28 06:59:52 +02:00
parent 1ab90dd9e2
commit 4e9dd036e7
2 changed files with 48 additions and 12 deletions
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -1578,6 +1578,30 @@ Description
    ``gallery``.


+extractor.civitai.nsfw
+----------------------
+Type
+    * ``bool``
+    * ``string`` (``"api": "rest"``)
+    * ``integer`` (``"api": "trpc"``)
+Default
+    ``true``
+Description
+    Download images rated NSFW.
+
+    * For ``"api": "rest"``, this can be one of
+      ``"None"``, ``"Soft"``, ``"Mature"``, ``"X"``
+      to set the highest returned mature content flag.
+
+    * For ``"api": "trpc"``, this can be an ``integer``
+      whose bits select the returned mature content flags.
+
+      For example, ``12`` (``4|8``)  would return only
+      ``Mature`` and ``X`` rated images,
+      while ``3`` (``1|2``) would return only
+      ``None`` and ``Soft`` rated images,
+
+
 extractor.civitai.quality
 -------------------------
 Type