Integrações
Bibliotecas oficiais para proteger chatbots, agentes e pipelines de RAG. Todas usam a mesma API, com os mesmos vereditos, limites e códigos de erro, e têm licença MIT.
Python
v0.1.0Cliente síncrono e assíncrono, respostas tipadas, novas tentativas automáticas e erros por tipo.
pip install maskena
Node.js / TypeScript
v0.1.0Tipos TypeScript, ESM e CommonJS, sem dependências: usa o fetch nativo.
npm install maskena
LangChain
v0.1.0Bloqueia a entrada perigosa antes do prompt, filtra documentos recuperados e carrega arquivos já limpos.
pip install langchain-maskena
LlamaIndex
v0.1.0Reader com o conteúdo seguro do documento e postprocessor que filtra os trechos antes do LLM.
pip install llama-index-maskena
API REST
v1Para qualquer outra linguagem: HTTPS e JSON, com especificação OpenAPI 3.1 para gerar clientes.
curl -X POST https://maskena.com/api/v1/check
Qual usar
| Você quer | Use |
|---|---|
| Verificar a mensagem do usuário antes de mandar ao modelo | check() no SDK, ou MaskenaGuard numa chain do LangChain |
| Verificar arquivos enviados por usuários (currículos, contratos, anexos) | scan() no SDK Python ou Node.js |
| Indexar documentos num RAG só com o conteúdo seguro | MaskenaLoader (LangChain), MaskenaReader (LlamaIndex) ou sanitize() no SDK |
| Impedir que um trecho recuperado do índice dê ordens ao modelo | MaskenaDocumentCompressor (LangChain) ou MaskenaNodePostprocessor (LlamaIndex) |
| Outra linguagem ou plataforma | API REST, com a especificação OpenAPI |
Python
from maskena import Maskena
client = Maskena() # lê MASKENA_API_KEY
resultado = client.check(mensagem_do_usuario, clean=True)
if resultado.flagged:
texto = resultado.clean_text # ou bloquear / pedir revisão
Node.js e TypeScript
import { Maskena } from "maskena";
const client = new Maskena(); // lê MASKENA_API_KEY
const resultado = await client.check(mensagemDoUsuario, { clean: true });
if (resultado.flagged) {
// bloquear, pedir revisão ou seguir com resultado.clean_text
}
LangChain
from langchain_classic.retrievers import ContextualCompressionRetriever
from langchain_maskena import MaskenaDocumentCompressor, MaskenaGuard, MaskenaLoader
docs = MaskenaLoader("manual.pdf").load() # só o conteúdo seguro, em trechos
vector_store.add_documents(docs)
retriever = ContextualCompressionRetriever(
base_compressor=MaskenaDocumentCompressor(), # descarta trechos perigosos recuperados
base_retriever=vector_store.as_retriever(),
)
chain = {"question": MaskenaGuard()} | prompt | llm # bloqueia a entrada perigosa
LlamaIndex
from llama_index.core import VectorStoreIndex
from llama_index_maskena import MaskenaNodePostprocessor, MaskenaReader
documents = MaskenaReader().load_data(["contrato.pdf", "manual.docx"])
index = VectorStoreIndex.from_documents(documents)
engine = index.as_query_engine(node_postprocessors=[MaskenaNodePostprocessor()])
resposta = engine.query("Qual é o prazo de reembolso?")
Nas integrações, o padrão é descartar o que é perigoso e seguir com a versão limpa do que é suspeito.
As duas coisas são configuráveis (block_on e use_clean_text).
Pacotes e versões
| Pacote | Registro | Versão | Requisitos |
|---|---|---|---|
maskena | PyPI | 0.1.0 | Python 3.9+ |
maskena | npm | 0.1.0 | Node.js 18+ |
langchain-maskena | PyPI | 0.1.0 | Python 3.11+, langchain-core 1.x |
llama-index-maskena | PyPI | 0.1.0 | Python 3.11+, llama-index-core 0.14 |
Versões e compatibilidade
- A API está na versão 1 (
/api/v1). Mudanças incompatíveis só entram numa nova versão do caminho, com aviso prévio; a versão atual continua funcionando. - Os códigos de erro (
code) e os valores deverdicteseveritynão mudam. Campos novos podem aparecer nas respostas: as bibliotecas os preservam. - As bibliotecas seguem versionamento semântico: atualizações de correção e de recursos não quebram o seu código.
- Todas repetem automaticamente as requisições em limite de taxa (respeitando
Retry-After) e em falhas do servidor, sem repetir envios que possam ter sido cobrados.
Custos
Cada texto ou trecho verificado usa uma verificação de texto da cota mensal; cada página enviada para limpeza usa uma página da cota de RAG. O plano Grátis inclui 1.000 verificações de texto e 30 páginas por mês. Ver planos.
Comece em poucos minutos
Crie a conta, gere a chave em API e instale o pacote da sua linguagem.