Add profanity filter support in translation

Author: spirokristollari

examples/text_translation.py

@@ -24,7 +24,7 @@ def main():
 
     credentials = AccessKey(access_key_id, access_key_secret)
     lara = Translator(credentials)
-    
+
     try:
         # Example 1: Basic single string translation
         print("=== Basic Single String Translation ===")
@@ -48,7 +48,7 @@ def main():
             TextBlock(text='<div class="separator"></div>', translatable=False),  # Non-translatable HTML
             TextBlock(text="Every page you turn is a new journey, and the best part?", translatable=True)
         ]
-        
+
         result3 = lara.translate(text_blocks, target="it-IT", source="en-US")
         print(f"Original TextBlocks: {len(text_blocks)} blocks")
         print(f"Translated blocks: {len(result3.translation)}")
@@ -91,7 +91,21 @@ def main():
         print("Original: This is a comprehensive translation example")
         print(f"Italian (with all options): {result6.translation}\n")
 
-        # Example 7: Get available languages
+        # Example 7: Profanity filter options
+        print("=== Translation with Profanity Filter Options ===")
+        profanity_text = "Don't be such a tool."
+        detect_result = lara.translate(profanity_text, target="it-IT", source="en-US",
+                                       profanity_filter="detect", verbose=True)
+        hide_result = lara.translate(profanity_text, target="it-IT", source="en-US",
+                                     profanity_filter="hide", verbose=True)
+        avoid_result = lara.translate(profanity_text, target="it-IT", source="en-US",
+                                      profanity_filter="avoid", verbose=True)
+        print(f"Original: {profanity_text}")
+        print(f"Detect mode translation: {detect_result.translation}")
+        print(f"Hide mode translation: {hide_result.translation}")
+        print(f"Avoid mode translation: {avoid_result.translation}\n")
+
+        # Example 8: Get available languages
         print("=== Available Languages ===")
         languages = lara.languages()
         print(f"Supported languages: {languages}")
@@ -100,4 +114,4 @@ def main():
         print(f"Error: {error}")
 
 if __name__ == "__main__":
-    main() 
+    main()

src/lara_sdk/__init__.py

@@ -1,7 +1,7 @@
 from ._client import LaraObject
 from ._credentials import Credentials, AccessKey, AuthToken
 from ._errors import LaraApiError, LaraError
-from ._translator import Memory, MemoryImport, TextBlock, TextResult, DetectPrediction, DetectResult, Memories, Translator, TranslatePriority, UseCache, Documents, Document, DocumentStatus, DocxExtractionParams, DocumentExtractionParams, GlossaryTerm, Audio, AudioStatus, AudioTranslator, AudioOptions, VoiceGender, ImageParagraph, ImageTranslator
+from ._translator import Memory, MemoryImport, TextBlock, TextResult, DetectPrediction, DetectResult, Memories, Translator, TranslatePriority, UseCache, Documents, Document, DocumentStatus, DocxExtractionParams, DocumentExtractionParams, GlossaryTerm, Audio, AudioStatus, AudioTranslator, AudioOptions, VoiceGender, ImageParagraph, ImageTranslator, ProfanityDetectResult
 
 # This constant is auto-generated by the build script.
 # Manual modifications will be overwritten and may cause unexpected behavior.

src/lara_sdk/_translator.py

@@ -15,6 +15,7 @@
 from ._s3client import S3Client, S3UploadFields
 
 TranslationStyle = Literal["faithful", "fluid", "creative"]
+ProfanityFilter = Literal["detect", "avoid", "hide"]
 GlossaryFileFormat = Literal["csv/table-uni", "csv/table-multi"]
 
 # Objects --------------------------------------------------------------------------------------------------------------
@@ -114,6 +115,11 @@ def __init__(self, **kwargs):
         self.text: str = kwargs.get('text')
         self.translatable: bool = kwargs.get('translatable', True)
 
+class ProfanityDetectResult(LaraObject):
+    def __init__(self, **kwargs):
+        self.masked_text: Optional[str] = kwargs.get('masked_text')
+        self.profanities: List[dict] = kwargs.get('profanities', [])
+
 class NGMemoryMatch(LaraObject):
     def __init__(self, **kwargs):
         self.memory: str = kwargs.get('memory')
@@ -138,6 +144,18 @@ def __init__(self, **kwargs):
         self.glossaries: Optional[List[str]] = kwargs.get('glossaries', None)
         self.adapted_to_matches: Optional[Union[List[NGMemoryMatch], List[Optional[List[NGMemoryMatch]]]]] = None
         self.glossaries_matches: Optional[Union[List[NGGlossaryMatch], List[Optional[List[NGGlossaryMatch]]]]] = None
+        self.profanities: Optional[Union[ProfanityDetectResult, List[Optional[ProfanityDetectResult]]]] = None
+
+        # Parse profanities
+        raw_profanities = kwargs.get('profanities', None)
+        if raw_profanities is not None:
+            if isinstance(raw_profanities, dict):
+                self.profanities = ProfanityDetectResult(**raw_profanities)
+            elif isinstance(raw_profanities, list):
+                self.profanities = [
+                    ProfanityDetectResult(**p) if p is not None else None
+                    for p in raw_profanities
+                ]
 
         # Parse adapted_to_matches
         adapted_to_matches = kwargs.get('adapted_to_matches', None)
@@ -686,6 +704,7 @@ def translate(self, text: Union[str, Iterable[str], Iterable[TextBlock]], *,
                   no_trace: bool = False, verbose: bool = False, style: Optional[TranslationStyle] = None,
                   headers: Optional[Dict[str, str]] = None, reasoning: bool = False,
                   metadata: Optional[Union[str, Dict]] = None,
+                  profanity_filter: Optional[ProfanityFilter] = None,
                   callback: Optional[Callable[[TextResult], None]] = None) -> TextResult:
         if isinstance(text, str):
             q = text
@@ -710,7 +729,7 @@ def translate(self, text: Union[str, Iterable[str], Iterable[TextBlock]], *,
             'priority': priority.value if priority is not None else None,
             'use_cache': use_cache.value if use_cache is not None else None, 'cache_ttl': cache_ttl_s,
             'glossaries': glossaries, 'verbose': verbose, 'style': style, 'reasoning': reasoning,
-            'metadata': metadata
+            'metadata': metadata, 'profanity_filter': profanity_filter
         }
 
         request_headers = {}