redaction

{'type': 'object', 'required': ['text'], 'properties': {'text': {'type': 'string', 'description': 'The text to redact.'}, 'allow': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Terms to leave as written — a shared mailbox, a product name a detector mistakes for a person.'}, 'strict': {'type': 'boolean', 'description': "Refuse rather than proceed when the name check cannot run. Use for records rather than one person's messages."}}}

{'type': 'object', 'required': ['text', 'map', 'redacted', 'names_decided'], 'properties': {'map': {'type': 'object', 'description': 'Stand-in to real value. Needed by restore, and stored nowhere else.', 'additionalProperties': {'type': 'string'}}, 'text': {'type': 'string', 'description': 'The text with stand-ins in place of the real values.'}, 'redacted': {'type': 'integer', 'description': 'How many values were replaced.'}, 'names_decided': {'type': 'boolean', 'description': 'Whether the name check reached a decision. False means it could not run, not that no names were found.'}}}

{'type': 'object', 'required': ['text', 'map'], 'properties': {'map': {'type': 'object', 'description': 'The map returned by redact.', 'additionalProperties': {'type': 'string'}}, 'text': {'type': 'string', 'description': "Usually a model's reply, containing stand-ins."}}}

{'type': 'object', 'required': ['text', 'restored'], 'properties': {'text': {'type': 'string', 'description': 'The text with the real values put back.'}, 'restored': {'type': 'integer', 'description': 'How many values were replaced.'}}}