A função AI_PII_MASK identifica e mascara informações de identificação pessoal (PII) em textos. Esse recurso protege a privacidade em logs de atendimento ao cliente, arquivamento de tickets e dados analíticos.
Pré-requisitos
Antes de usar a AI_PII_MASK, verifique se você tem os seguintes itens:
Um endpoint de cluster Milvus (por exemplo,
http://c-xxxx.milvus.aliyuncs.com:19530).Credenciais de autenticação no formato
<yourUsername>:<yourPassword>.Um modelo de texto configurado (por exemplo,
qwen3.7-max).(Apenas Python) PyMilvus instalado.
Formato do comando
A AI_PII_MASK oferece dois métodos de invocação:
Interface REST — Chame a API diretamente para mascarar textos sob demanda.
Função de Coleção Python — Adicione uma função ao schema da coleção para mascarar automaticamente as PII durante a gravação de dados.
Interface REST
Interface REST
@id="c0053k7q2t53"
Envie uma solicitação POST para o endpoint /v2/vectordb/ai/pii_mask:
POST /v2/vectordb/ai/pii_mask
Content-Type: application/json
{
"model_name": "<model name>",
"texts": ["<text>"],
"params": {"pii_types": ["EMAIL", "PHONE"]}
}
@id="cmdpysecpii01"
@id="cmdpyhpii0001"
Python (Função de Coleção)
Python (Função de Coleção)
@id="cmdpycodpii01"
Defina um schema com uma Function que use o tipo de função TEXTTRANSFORM. O auxiliar texttransform_function_type() abaixo gerencia a compatibilidade entre versões do PyMilvus. Para ver a implementação completa, consulte o Python usage example.
schema = MilvusClient.create_schema(auto_id=True, enable_dynamic_field=False)
schema.add_field("id", DataType.INT64, is_primary=True)
schema.add_field("content", DataType.VARCHAR, max_length=4096)
schema.add_field("masked", DataType.VARCHAR, max_length=4096)
schema.add_field("dummy_vector", DataType.FLOAT_VECTOR, dim=2)
schema.add_function(
Function(
name="mask_pii",
function_type=texttransform_function_type(),
input_field_names=["content"],
output_field_names=["masked"],
params={
"provider": "aliyun_milvus",
"model_name": "<model name>",
"task": "ai_pii_mask",
"pii_types": "PERSON,EMAIL,PHONE",
"mask_char": "*",
"preserve_length": "true",
"temperature": "0",
},
)
)
Parâmetros
|
@id="p0060k7q2t60" Parâmetro |
@id="p0062k7q2t62" Descrição |
|
@id="p0003k7q2t03" |
@id="p0005k7q2t05" Obrigatório. Nome do modelo de texto configurado. |
|
@id="p0008k7q2t08" |
@id="p0010k7q2t10" Obrigatório para REST. Array de textos a mascarar. |
|
@id="p0013k7q2t13" |
@id="p0015k7q2t15" Opcional. Tipos de PII a mascarar. Aceita um array ou string separada por vírgulas; suporta de 1 a 30 tipos. Por padrão, mascara nomes, endereços de e-mail, números de telefone, números de identificação, números de cartões bancários, endereços físicos, URLs, endereços IP, tokens e senhas. |
|
@id="p0018k7q2t18" |
@id="p0020k7q2t20" Opcional. Caractere único de substituição. O padrão é |
|
@id="p0023k7q2t23" |
@id="p0025k7q2t25" Opcional. Indica se o comprimento do segmento sensível original deve ser preservado. O padrão é |
|
@id="p0028k7q2t28" |
@id="p0030k7q2t30" Opcional. Configurações de estabilidade do modelo, concorrência e tempo limite. |
|
@id="p0033k7q2t33" |
@id="p0035k7q2t35" Obrigatório apenas para Função de Coleção. Valores fixos: |
Resposta
data.output.outputs retorna o texto mascarado na mesma ordem da entrada. Ao usar uma Função de Coleção, o resultado é gravado no campo de texto de destino.
Exemplo de uso: mascaramento de logs de atendimento antes do armazenamento
As equipes de operações precisam manter registros de contato para análises, mas não podem armazenar nomes, endereços de e-mail ou números de telefone no banco de dados analítico. O exemplo a seguir mascara uma entrada de log via REST e demonstra como mascarar dados automaticamente durante a gravação com uma Função de Coleção.
Interface REST
Interface REST
@id="c0072k7q2t72"
Execute o script abaixo para mascarar PII em uma entrada de log de exemplo:
#!/usr/bin/env bash
set -euo pipefail
MILVUS_REST_BASE_URL="http://c-xxxx.milvus.aliyuncs.com:19530"
MILVUS_AUTH_TOKEN="<yourUsername>:<yourPassword>"
post_json() {
local path="$1"
local body="$2"
curl -X POST \
"$MILVUS_REST_BASE_URL$path" \
-H "Authorization: Bearer $MILVUS_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d "$body"
}
MODEL_NAME="qwen3.7-max"
BODY=$(cat <<JSON
{
"model_name": "$MODEL_NAME",
"texts": ["Please contact Zhang San at zhangsan@example.com or +86 13812345678."],
"params": {
"pii_types": ["PERSON", "EMAIL", "PHONE"],
"mask_char": "*",
"preserve_length": true,
"temperature": 0
}
}
JSON
)
RESPONSE_BODY="$(post_json "/v2/vectordb/ai/pii_mask" "$BODY")"
if command -v jq >/dev/null 2>&1; then
echo "$RESPONSE_BODY" | jq .
[ "$(echo "$RESPONSE_BODY" | jq -r '.code // -1')" = "0" ] || exit 1
else
echo "$RESPONSE_BODY"
fi
# Expected: masked = Please contact ********* at ******************** or ***************.
@id="pt0073k7q2t73"
@id="h0074k7q2t74"
Python (Função de Coleção)
Python (Função de Coleção)
@id="p0075k7q2t75"
Após instalar o PyMilvus, substitua os placeholders MILVUS_URI e MILVUS_TOKEN pelo endereço e token reais do seu cluster e execute o script. As funções auxiliares comuns estão incluídas diretamente no exemplo.
@id="c0076k7q2t76"
from __future__ import annotations
from typing import Any
from pymilvus import DataType, Function, FunctionType, MilvusClient
MILVUS_URI = "http://c-xxxx.milvus.aliyuncs.com:19530"
MILVUS_TOKEN = "<yourUsername>:<yourPassword>"
DUMMY_VECTOR_DIM = 2
TEXTTRANSFORM_FUNCTION_TYPE = 9
def texttransform_function_type() -> Any:
for type_name in ("TEXTTRANSFORM", "TEXT_TRANSFORM", "TextTransform"):
function_type = getattr(FunctionType, type_name, None)
if function_type is not None:
return function_type
# Alibaba Cloud Milvus provides TEXTTRANSFORM as a managed extension (function type value 9);
# some pymilvus versions do not include this enum member natively, yet Function(...) validates through FunctionType(...).
existing = getattr(FunctionType, "_value2member_map_", {}).get(TEXTTRANSFORM_FUNCTION_TYPE)
if existing is not None:
return existing
extension = int.__new__(FunctionType, TEXTTRANSFORM_FUNCTION_TYPE)
extension._name_ = "TEXTTRANSFORM"
extension._value_ = TEXTTRANSFORM_FUNCTION_TYPE
FunctionType._value2member_map_[TEXTTRANSFORM_FUNCTION_TYPE] = extension
FunctionType._member_map_["TEXTTRANSFORM"] = extension
return extension
def add_id(schema: Any) -> None:
schema.add_field("id", DataType.INT64, is_primary=True)
def add_dummy_vector(schema: Any) -> None:
schema.add_field("dummy_vector", DataType.FLOAT_VECTOR, dim=DUMMY_VECTOR_DIM)
def run_texttransform_example(*, client, collection_name, input_fields, output_field, function_name, function_params, rows) -> None:
if client.has_collection(collection_name):
client.drop_collection(collection_name)
schema = MilvusClient.create_schema(auto_id=True, enable_dynamic_field=False)
add_id(schema)
for name, data_type, max_length in input_fields:
field_params = {"max_length": max_length} if max_length is not None else {}
schema.add_field(name, data_type, **field_params)
output_name, output_data_type, output_max_length = output_field
output_params = {"max_length": output_max_length} if output_max_length is not None else {}
schema.add_field(output_name, output_data_type, **output_params)
add_dummy_vector(schema)
schema.add_function(
Function(
name=function_name,
function_type=texttransform_function_type(),
input_field_names=[name for name, _, _ in input_fields],
output_field_names=[output_name],
params=function_params,
)
)
index_params = client.prepare_index_params()
index_params.add_index(field_name="dummy_vector", index_type="AUTOINDEX", metric_type="COSINE")
client.create_collection(collection_name=collection_name, schema=schema, index_params=index_params)
client.insert(collection_name, rows)
client.flush(collection_name)
fields = [name for name, _, _ in input_fields] + [output_name]
for row in client.query(collection_name, filter="", output_fields=fields, limit=len(rows)):
print(row)
MODEL_NAME = "qwen3.7-max"
client = MilvusClient(uri=MILVUS_URI, token=MILVUS_TOKEN)
run_texttransform_example(
client=client,
collection_name="simple_ai_pii_mask",
input_fields=[("content", DataType.VARCHAR, 4096)],
output_field=("masked", DataType.VARCHAR, 4096),
function_name="mask_pii",
function_params={"provider": "aliyun_milvus", "model_name": MODEL_NAME, "task": "ai_pii_mask", "pii_types": "PERSON,EMAIL,PHONE", "mask_char": "*", "preserve_length": "true", "temperature": "0"},
rows=[{"content": "Please contact Zhang San at zhangsan@example.com or +86 13812345678.", "dummy_vector": [0.1, 0.2]}],
)
# Expected: masked = Please contact ********* at ******************** or ***************.
Resultado esperado: masked retorna Please contact ********* at ******************** or ***************. — o nome, o endereço de e-mail e o número de telefone são mascarados com seus comprimentos originais preservados, tornando seguro gravar os dados na coleção de análise.