API PII nativa v2

Detecte, proteja y restaure datos personales en texto, tablas, JSON, transcripciones, imágenes, audio y documentos con un solo contrato.

Un solo contrato para cada despliegue

El mismo cuerpo de solicitud funciona con la API alojada, el entorno de pruebas y una instalación en su propio clúster. La edición sin conexión ofrece la API nativa v1 hasta que su imagen incluya la v2. Las rutas v1 y los contratos de Azure, AWS y Google siguen disponibles.

Funciones de un vistazo

Cada función tiene una explicación de una línea y una solicitud mínima. Las secciones siguientes dan los detalles.

export SHINRAI_API_KEY=shr_live_...

Entradas

Texto Encuentre datos personales en un texto. Cada entidad vuelve con su tipo, su posición y su confianza.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" -d '{"text": "Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}'

curl 'https://azure.api.shinrai.innovius.io/language/:analyze-text?api-version=2023-04-01' \
  -H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

# Once: create SigV4 credentials with your ShinrAI key
# curl -X POST https://aws.api.shinrai.innovius.io/providers/aws/credentials -H "Authorization: Bearer $SHINRAI_API_KEY"
import boto3, os

client = boto3.client(
    "comprehend",
    region_name="eu-central-1",
    endpoint_url="https://aws.api.shinrai.innovius.io",
    aws_access_key_id=os.environ["SHINRAI_AWS_ACCESS_KEY_ID"],
    aws_secret_access_key=os.environ["SHINRAI_AWS_SECRET_ACCESS_KEY"],
)
print(client.detect_pii_entities(Text="Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00", LanguageCode="en"))

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

curl 'https://google.api.shinrai.innovius.io/v2/projects/my-project/locations/global/content:inspect' \
  -H "x-goog-api-key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item":{"value":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"},"inspectConfig":{"includeQuote":true}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

Varios textos Envíe hasta 256 textos en una solicitud. Una solicitud mantiene un solo mapa de reemplazos para todos ellos.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" -d '{"texts": ["Anna Weber called.", "Call Anna Weber back at +49 30 1234567."]}'

Archivos de texto Envíe un archivo de texto tal cual y reciba el texto protegido.

curl -s "https://api.shinrai.innovius.io/v2/protect?preset=label" -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: text/plain" -H "Accept: text/plain" --data-binary @letter.txt

# Azure returns the masked text as redactedText.
curl 'https://azure.api.shinrai.innovius.io/language/:analyze-text?api-version=2023-04-01' \
  -H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

curl 'https://google.api.shinrai.innovius.io/v2/projects/my-project/locations/global/content:deidentify' \
  -H "x-goog-api-key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item":{"value":"Anna Weber, anna.weber@example.org"},"deidentifyConfig":{"infoTypeTransformations":{"transformations":[{"primitiveTransformation":{"replaceWithInfoTypeConfig":{}}}]}}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

Tablas Proteja filas y columnas. Cada entidad indica su fila y su columna.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"inputs": [{"kind": "table", "columns": [{"name": "name"}, {"name": "email"}], "rows": [["Anna Weber", "anna@example.org"]]}]}'

JSON Proteja cada cadena de un valor JSON, por ejemplo una llamada a una herramienta. Cada entidad lleva un JSON Pointer a su cadena.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"inputs": [{"kind": "json", "value": {"customer": {"name": "Anna Weber", "email": "anna@example.org"}}}]}'

Transcripciones Envíe una transcripción con los tiempos de cada palabra. Cada entidad vuelve con los tiempos de sus palabras.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"inputs": [{"kind": "transcript", "forms": {"display": "Call Anna Weber"}, "atoms_form": "display", "time_unit": "ms",
       "atoms": [{"text": "Call", "t0": 0, "t1": 300}, {"text": "Anna", "t0": 350, "t1": 600}, {"text": "Weber", "t0": 600, "t1": 950}]}]}'

Páginas Envíe el texto de una página con los recuadros de palabras de su propio OCR o de la capa de texto del PDF. Cada entidad vuelve con sus recuadros.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"inputs": [{"kind": "page", "text": "Anna Weber", "box_unit": "px",
       "atoms": [{"start": 0, "end": 4, "page": 1, "box": [10, 20, 40, 12]}, {"start": 5, "end": 10, "page": 1, "box": [54, 20, 50, 12]}]}]}'

Imágenes Encuentre datos personales en una captura de pantalla o un escaneo. El OCR lee 14 idiomas y cada entidad vuelve con recuadros en píxeles.

curl -s "https://api.shinrai.innovius.io/v2/detect?language=de" -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: image/png" --data-binary @screenshot.png

Imágenes censuradas Reciba la imagen censurada, con cada entidad rellenada en negro.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: image/png" -H "Accept: image/png" --data-binary @screenshot.png -o redacted.png

# Google returns the redacted image as redactedImage.
curl 'https://google.api.shinrai.innovius.io/v2/projects/my-project/image:redact' \
  -H "x-goog-api-key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"byteItem":{"type":"IMAGE_PNG","data":"'"$(base64 < screenshot.png | tr -d '\n')"'"}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

Audio (beta) Envíe una grabación de hasta 5 minutos y recíbala con cada dato personal cubierto con un pitido.

curl -sS "https://api.shinrai.innovius.io/v2/protect?language=de" -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: audio/mpeg" -H "Accept: audio/wav" --data-binary @call.mp3 -o call.redacted.wav

Transcripciones de audio (beta) Reciba la transcripción de una grabación y los tiempos de cada entidad, sin el audio.

curl -sS "https://api.shinrai.innovius.io/v2/detect?language=de" -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: audio/mpeg" --data-binary @call.mp3

Detección

Idioma y modelo Indique el idioma para obtener los mejores resultados y fije una versión del modelo cuando necesite los mismos resultados a lo largo del tiempo.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber wohnt in Darmstadt.", "detection": {"language": "de", "model": "latest"}}'

Tipos Incluya o excluya tipos por sus nombres de ShinrAI o por los nombres de Google, AWS, Azure o Presidio.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber, anna@example.org, +49 30 1234567", "detection": {"types": {"include": ["EMAIL_ADDRESS", "PHONE_NUMBER"], "vocabulary": "google"}}}'

Umbrales de confianza Fije un umbral de confianza para todos los tipos, por tipo o por idioma.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber, Darmstadt", "detection": {"thresholds": {"default": 0.5, "per_type": {"CITY": 0.8}}}}'

Valores ignorados y sus propios valores No notifique nunca valores como el nombre de su empresa y encuentre sus propios valores con un tipo.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Innovius support: case K-4711 for Anna Weber", "detection": {"exclude_values": {"values": ["Innovius"]},
       "custom": {"user_values": [{"value": "K-4711", "type": "CUSTOMER_ID"}]}}}'

Sus propios rangos Proteja los rangos que encontró su propio detector, solos o junto con la detección de ShinrAI.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"inputs": [{"kind": "text", "text": "Ticket for Anna Weber", "entities": [{"type": "PERSON", "span": {"start": 11, "end": 21}}]}],
       "detection": {"mode": "provided"}}'

Textos largos Elija cómo lee el modelo un texto largo: automático, frase por frase o como un solo bloque.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber called. She lives in Darmstadt.", "detection": {"spans": {"segment": "sentence"}}}'

Protección

Seudonimización Seudonimice y conserve el mapeo para poder restaurar una respuesta más adelante.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber lives in Darmstadt.", "policy": {"preset": "pseudonymize"}, "output": {"include": ["entities", "mapping"]}}'

# Azure returns the masked text as redactedText.
curl 'https://azure.api.shinrai.innovius.io/language/:analyze-text?api-version=2023-04-01' \
  -H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber lives in Darmstadt."}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

curl 'https://google.api.shinrai.innovius.io/v2/projects/my-project/locations/global/content:deidentify' \
  -H "x-goog-api-key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item":{"value":"Anna Weber lives in Darmstadt."},"deidentifyConfig":{"infoTypeTransformations":{"transformations":[{"primitiveTransformation":{"replaceWithInfoTypeConfig":{}}}]}}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

Etiquetas y máscaras Reemplace cada valor por una etiqueta numerada como [PERSON_1] o enmascárelo con un carácter.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber, anna@example.org", "policy": {"preset": "label", "rules": [{"types": ["EMAIL"], "action": "mask", "mask": {"char": "*"}}]}}'

# Azure returns the masked text as redactedText.
curl 'https://azure.api.shinrai.innovius.io/language/:analyze-text?api-version=2023-04-01' \
  -H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna@example.org"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

curl 'https://google.api.shinrai.innovius.io/v2/projects/my-project/locations/global/content:deidentify' \
  -H "x-goog-api-key: $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item":{"value":"Anna Weber, anna@example.org"},"deidentifyConfig":{"infoTypeTransformations":{"transformations":[{"primitiveTransformation":{"replaceWithInfoTypeConfig":{}}}]}}}'

Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.

Valores parciales y generalizados Conserve el dominio del correo y los últimos cuatro dígitos de una tarjeta, y generalice nombres y lugares.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber aus Biberach, anna@example.org, Karte 4111 1111 1111 1111", "language": "de",
       "policy": {"default": {"action": "generalize"}, "rules": [{"types": ["EMAIL", "CREDIT_CARD"], "action": "partial"}]}}'

Reglas por tipo Elija una acción por tipo: reemplazar por un texto fijo, eliminar o conservar.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber from Darmstadt, +49 30 1234567, anna@example.org", "policy": {"preset": "pseudonymize",
       "rules": [{"types": ["PHONE"], "action": "replace", "replace": {"value": "[phone]"}}, {"types": ["EMAIL"], "action": "remove"},
                 {"types": ["CITY"], "action": "keep"}]}}'

Salidas

Anotaciones Reciba años, importes, referencias legales y términos de sesgo como anotaciones. Protect nunca los modifica.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "In 2019 Anna Weber paid 1,200 EUR.", "output": {"include": ["entities", "annotations"]}}'

Riesgo de vinculación Estime la probabilidad de que un texto singularice a una persona. Es una heurística, no un recuento.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "The 34-year-old head surgeon from Biberach joined in 2019.", "output": {"include": ["entities", "linkage_risk"]}}'

Desplazamientos, textos y estadísticas Reciba las posiciones en UTF-16 o UTF-8, los textos de las entidades, estadísticas y una lista de entidades más corta.

curl -s https://api.shinrai.innovius.io/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber, anna@example.org", "output": {"offset_unit": "utf16", "include_text": true, "include": ["entities", "stats"], "max_entities": {"per_input": 10}}}'

Restauración y sesiones

Restauración Restaure un texto que contiene los sustitutos. Envíe las entradas de mapping.delta como pares de original y reemplazo.

curl -s https://api.shinrai.innovius.io/v2/restore -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mapping": {"known": [{"original": "Anna Weber", "replacement": "Julia Brandt"}]}, "inputs": [{"id": "1", "text": "Julia Brandt replied."}]}'

Tablas de restauración Compile un mapeo en una tabla de restauración y restaure en su propio código, por ejemplo en una respuesta del modelo transmitida en streaming.

curl -s https://api.shinrai.innovius.io/v2/restore-tables -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"mapping": {"known": [{"original": "Anna Weber", "replacement": "Julia Brandt"}]}}'

Un solo reemplazo Reciba un reemplazo para un valor y un tipo que usted elija.

curl -s https://api.shinrai.innovius.io/v2/replacements -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"value": "Anna Weber", "type": "PERSON", "language": "de"}'

Sesiones Mantenga un mapa en muchas solicitudes con una sesión (24 horas como máximo) y después expórtelo.

SESSION=$(curl -s -X POST https://api.shinrai.innovius.io/v2/sessions -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" -d '{"ttl_s": 3600}' | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" -d '{"text": "Anna Weber called.", "mapping": {"session": "'$SESSION'"}}'
curl -s https://api.shinrai.innovius.io/v2/sessions/$SESSION/mapping -H "Authorization: Bearer $SHINRAI_API_KEY"

Pares conocidos Pase los pares anteriores a una solicitud nueva para que los mismos valores mantengan los mismos sustitutos.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"text": "Anna Weber called again.", "mapping": {"known": [{"original": "Anna Weber", "replacement": "Julia Brandt"}]}}'

Trabajos (beta)

Lotes de textos Proteja hasta 20.000 textos de un archivo JSONL en segundo plano, a mitad de precio.

UPLOAD=$(curl -s https://api.shinrai.innovius.io/v2/uploads -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/x-ndjson" --data-binary @rows.jsonl | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -s https://api.shinrai.innovius.io/v2/jobs -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"kind": "text_batch", "inputs": [{"kind": "file", "source": {"upload": "'$UPLOAD'"}}]}'

Documentos Proteja el texto de un archivo PDF o Word.

UPLOAD=$(curl -s https://api.shinrai.innovius.io/v2/uploads -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/pdf" --data-binary @contract.pdf | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -s https://api.shinrai.innovius.io/v2/jobs -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"kind": "document", "inputs": [{"kind": "file", "source": {"upload": "'$UPLOAD'"}}]}'

Grabaciones largas Cubra con pitidos una grabación de hasta 60 minutos en segundo plano.

UPLOAD=$(curl -s https://api.shinrai.innovius.io/v2/uploads -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: audio/mpeg" --data-binary @meeting.mp3 | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -s https://api.shinrai.innovius.io/v2/jobs -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"kind": "audio", "inputs": [{"kind": "audio", "source": {"upload": "'$UPLOAD'"}, "language": "de"}]}'

Niveles, reintentos y cuenta

Niveles Elija tiempo real para entradas pequeñas con baja latencia, o por lotes a mitad de precio.

curl -s "https://api.shinrai.innovius.io/v2/detect?tier=realtime" -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: text/plain" --data-binary 'Call Anna Weber at +49 30 1234567.'

Reintentos seguros Reintente con el mismo Idempotency-Key. El servicio cobra la solicitud una sola vez.

curl -s https://api.shinrai.innovius.io/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Idempotency-Key: order-4711" \
  -H "Content-Type: application/json" -d '{"text": "Anna Weber, order 4711"}'

Capacidades Lo que ofrece este despliegue: modelos, idiomas, tipos de entrada, niveles que permite su plan y límites.

curl -s https://api.shinrai.innovius.io/v2/capabilities -H "Authorization: Bearer $SHINRAI_API_KEY"

Lista de tipos Liste cada tipo con su descripción y los nombres de Google, AWS, Azure y Presidio.

curl -s https://api.shinrai.innovius.io/v2/types -H "Authorization: Bearer $SHINRAI_API_KEY"

Uso Su saldo y los últimos 30 días.

curl -s https://api.shinrai.innovius.io/v2/usage -H "Authorization: Bearer $SHINRAI_API_KEY"

OpenAPI Obtenga el documento OpenAPI 3.1 completo de la API v2.

curl -s https://api.shinrai.innovius.io/v2/openapi.json -o shinrai-pii-api-v2.json

Empezar por las capacidades

Lea las capacidades una vez al inicio. Enumeran los modelos, idiomas, tipos de entrada, niveles y límites de su despliegue.

curl -s https://api.shinrai.innovius.io/v2/capabilities -H "Authorization: Bearer $SHINRAI_API_KEY"

Enviar cualquier tipo de entrada

Un texto simple no necesita envoltorio. Para un archivo de texto, una imagen o una grabación, envíe el propio archivo como cuerpo de la solicitud y ponga las opciones en la cadena de consulta.

Entrada	Cómo enviarla	Notas
Texto	`{"text": "..."}` o `text/plain`	Enviar JSON o el archivo sin envoltorio
Tablas	`"kind": "table"`	Columnas y filas
JSON	`"kind": "json"`	Todas las cadenas del valor
Transcripciones	`"kind": "transcript"`	Formas y átomos de palabras con tiempos
Páginas	`"kind": "page"`	Texto más recuadros de palabras de su propio OCR o de la capa de texto del PDF
Imágenes	`image/png`, `image/jpeg`, `image/bmp`, `image/tiff`, `image/webp`	Hasta 6 MiB: OCR, recuadros en píxeles por entidad y la imagen censurada
Audio (beta)	`audio/wav`, `audio/mpeg`, `audio/ogg`, `audio/flac`, `audio/mp4`, `audio/aac`, `audio/webm`	Hasta 5 minutos y 12 MiB: intervalos de tiempo por entidad y la grabación con pitidos
Documentos	`POST /v2/jobs`	PDF y DOCX mediante un trabajo (beta)

Elegir cómo proteger

Un ajuste predefinido fija una política para todos los tipos. Las reglas fijan una acción por tipo.

Ajuste	Valores
Ajuste predefinido	`pseudonymize`, `mask`, `label`, `strict`
Acción por tipo	`surrogate`, `label`, `mask`, `partial`, `generalize`, `replace`, `remove`, `keep`

Pseudonymize escribe sustitutos realistas que puede restaurar.
Partial conserva lo que no identifica: el dominio del correo, el prefijo telefónico del país, los últimos cuatro dígitos de una tarjeta o cuenta, el año de una fecha.
Generalize escribe una frase para el tipo de nombre, lugar u organización, en el idioma de la entrada.
Partial y generalize son irreversibles.

Controlar la detección

Fije un umbral de confianza para todos los tipos, por tipo o por idioma.
Incluya o excluya tipos por sus nombres canónicos o por los nombres de Google, AWS, Azure o Presidio.
Excluya valores que nunca deben notificarse, como el nombre de su empresa, o añada sus propios valores.
Envíe los rangos de su propio detector, solos o junto con la detección de ShinrAI.
Solicite anotaciones: años, importes, referencias legales y términos de sesgo. Protect nunca los modifica.
Solicite el riesgo de vinculación: una estimación de la probabilidad de que una entrada singularice a una persona. Es una heurística, no un recuento.

Restaurar y mantener un mapa

Solicite el mapeo cuando deba restaurar una respuesta más adelante. El mapeo contiene los valores originales. Guárdelo como dato sensible de la aplicación y manténgalo fuera de los prompts del modelo.

Dentro de una solicitud, un valor mantiene un solo sustituto.
La siguiente solicitud genera nuevos sustitutos, por lo que las solicitudes repetidas no permiten volver de los sustitutos a los originales.
Para mantener los mismos sustitutos entre solicitudes, use una sesión o envíe los pares anteriores como mapeos conocidos.
La coherencia en toda la cuenta está disponible como opción. Es más débil: cualquiera con la clave puede entonces construir una tabla de originales por repetición.
Los demás clientes siempre reciben sustitutos distintos.
Las tablas de restauración le permiten restaurar en su propio código, por ejemplo en una respuesta del modelo transmitida en streaming.

Una sesión guarda un mapa en el servidor durante 24 horas como máximo. El mapa se almacena cifrado y solo su clave puede leerlo.

Proteger capturas de pantalla y escaneos

El OCR lee todos los idiomas que sirve el modelo. Indique el idioma para imágenes en árabe, hebreo, japonés y coreano.
Cada entidad vuelve con recuadros en píxeles, uno por línea de texto o uno por palabra.
Protect devuelve la imagen con las regiones rellenadas.
El nivel en tiempo real acepta una imagen por solicitud, hasta 4,2 megapíxeles y 3 MiB.

Proteger audio (beta)

Envíe una grabación de hasta 5 minutos y 12 MiB como cuerpo de una solicitud detect o protect en el nivel estándar.
Protect devuelve la grabación en WAV con cada dato personal cubierto con un pitido. Pida silencio en lugar del tono y amplíe los intervalos silenciados si lo necesita.
Pida JSON para recibir la transcripción protegida y los tiempos de cada entidad en lugar del audio.
Indique el idioma: el reconocimiento de voz y la detección leen entonces el idioma correcto.
El audio cuesta los registros de su transcripción, al menos 10 registros por minuto iniciado.
Solo se ejecuta una solicitud de audio por cuenta a la vez. Las grabaciones de hasta 60 minutos se ejecutan como trabajo.
Una palabra que el reconocimiento de voz entiende mal y que el modelo luego no detecta sigue siendo audible. Escuche las grabaciones sensibles antes de compartirlas.

Ejecutar lotes grandes, documentos y grabaciones como trabajos

Use un trabajo cuando la tarea es demasiado grande para una solicitud: muchos textos, un archivo PDF o Word, o una grabación larga. Un trabajo se ejecuta en segundo plano con el peso de lote y conserva sus resultados durante 24 horas. Los trabajos están en beta.

Suba un archivo JSONL con una entrada por línea, un archivo PDF o DOCX, o una grabación.
Inicie el trabajo con el ID de la subida.
Consulte el trabajo y descargue los artefactos.

{"custom_id": "row-1", "text": "Anna Schmidt, anna@example.com"}
{"custom_id": "row-2", "text": "Call +49 30 1234567", "language": "de"}
{"custom_id": "row-3", "input": {"kind": "table", "columns": [{"name": "email"}], "rows": [["max@example.org"]]}}

curl -s https://api.shinrai.innovius.io/v2/uploads \
  -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/x-ndjson" \
  --data-binary @rows.jsonl

curl -s https://api.shinrai.innovius.io/v2/jobs \
  -H "Authorization: Bearer $SHINRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: rows-2026-09-28" \
  -d '{"kind": "text_batch",
       "inputs": [{"kind": "file", "source": {"upload": "up_..."}}],
       "output": {"artifacts": ["protected", "entities"]}}'

curl -s https://api.shinrai.innovius.io/v2/jobs/$JOB -H "Authorization: Bearer $SHINRAI_API_KEY"

Un trabajo de documento protege el texto del documento. El PDF censurado y sus recuadros de palabras llegarán en una versión posterior. Un trabajo de audio devuelve el WAV censurado, la transcripción protegida y las entidades con sus tiempos.

Límites

La API alojada aplica estos límites. Las capacidades devuelven los valores de su despliegue.

Límite	Standard	Tiempo real	Batch	Trabajos
Entradas por solicitud	64	4	200	20.000 líneas
Caracteres por entrada	200.000	4.000	200.000	200.000
Cuerpo de la solicitud	12 MiB	12 MiB	12 MiB	Subida de 50 MB
Imagen	6 MiB	4,2 megapíxeles, 3 MiB	6 MiB	No se ofrece
Audio	5 minutos, 12 MiB	No se ofrece	No se ofrece	60 minutos, 50 MB
Documento	No se ofrece	No se ofrece	No se ofrece	PDF o DOCX, 10 MB

Una solicitud que supera un límite responde 413 y no se cobra. Su plan fija los niveles que puede usar y el número de solicitudes por minuto.

Niveles, reintentos y uso

Nivel	Peso	Ideal para
Standard	×1	Predeterminado
Batch	×0.5	Mitad de precio, prioridad más baja
Tiempo real	×1.6	Entradas pequeñas y baja latencia, desde el plan Team

Envíe un encabezado Idempotency-Key para reintentar con seguridad. Una repetición con la misma clave y el mismo cuerpo se cobra una sola vez.
La restauración, las sesiones, las capacidades, los tipos y el uso son gratuitos.
Las llamadas fallidas no se cobran.

Errores

Cada error tiene un código, un mensaje, el ID de solicitud y si un reintento puede tener éxito. Los errores de validación señalan el campo con un JSON Pointer y nunca repiten sus datos.

Reintente solo cuando el error indique que un reintento puede tener éxito, y espere el tiempo del encabezado Retry-After.
Un error de límite indica el límite. Para el audio, remite a la ruta de trabajos.
Una opción que su despliegue todavía no ofrece responde 501.

Próximamente

La entrada en streaming y el PDF censurado de los trabajos de documentos están previstos. Todavía no están disponibles.

API PII nativa v2

Funciones de un vistazo

Entradas

Detección

Protección

Salidas

Restauración y sesiones

Trabajos (beta)

Niveles, reintentos y cuenta

Empezar por las capacidades

Enviar cualquier tipo de entrada

Elegir cómo proteger

Controlar la detección

Restaurar y mantener un mapa

Proteger capturas de pantalla y escaneos

Proteger audio (beta)

Ejecutar lotes grandes, documentos y grabaciones como trabajos

Límites

Niveles, reintentos y uso

Errores

Próximamente

Referencia