mirror of
https://github.com/mudler/LocalAI.git
synced 2026-06-18 21:58:58 -04:00
feat(pii): NER tier engine — privacy-filter.cpp backend + NER-centric PII filter (#10360)
Squashed feat/pii-ner-tier-engine rebased onto master (was 45 commits; see backup/pii-ner-tier-engine-prerebase). Net change: - privacy-filter.cpp: standalone GGML engine for the openai-privacy-filter PII/NER token classifier, wired as a LocalAI gRPC backend (CPU/CUDA/Vulkan). TokenClassify moves off the patched llama.cpp path onto this backend. - PII filter reworked to be NER-centric (encoder/NER detection tier scanning whole conversations as one document), with a recreated bounded restricted- regex secret-matching pattern detector tier alongside it (per-model pii_detection.builtins / .patterns + core/services/routing/piipattern). - Detection labelled by source (ner vs pattern); backend trace / confidence / debug observability; analyze/redact exposed as a synchronous API. - Instance-wide default detector policy + per-usecase default-on; request filtering extended to completions, embeddings, edits & Ollama. - React UI: NER-centric PII editor, detector-models table, pattern/builtins editor, middleware default-policy UI. - Gallery: privacy-filter-multilingual token-classify model + NER install filter; token_classify known_usecase; batch sized to context for NER models. privacy-filter backend registered in the backend gallery (cpu/vulkan/cuda-13 meta + image entries with a capabilities map) matching its CI matrix jobs, and an /import-model auto-detect importer (PrivacyFilterImporter, narrow privacy-filter GGUF detection) replacing the prior pref-only registration. Reconciled against master's independent evolution: - Dropped master's PIIPatternOverrides feature (global-pattern runtime overrides + /api/pii/patterns API + runtime_settings.json persistence). The per-model NER + pattern-detector design supersedes it; it was built on the global redactor pattern set this branch replaced. - Reverted the llama.cpp Score carry-patch (0006-server-task-type-score): removed the patch and restored master's grpc-server.cpp Score RPC (direct llama_decode, slot-loop bypass) and LLAMA_VERSION pin, plus master's model_config validation forbidding score + chat/completion/embeddings on llama-cpp. token_classify is unaffected (it runs on the privacy-filter backend, not llama-cpp). Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Richard Palethorpe <io@richiejp.com>
This commit is contained in:
committed by
GitHub
parent
c133ca39dc
commit
3fa7b2955c
150
core/backend/token_classify.go
Normal file
150
core/backend/token_classify.go
Normal file
@@ -0,0 +1,150 @@
|
||||
package backend
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"github.com/mudler/LocalAI/core/config"
|
||||
"github.com/mudler/LocalAI/core/trace"
|
||||
pb "github.com/mudler/LocalAI/pkg/grpc/proto"
|
||||
model "github.com/mudler/LocalAI/pkg/model"
|
||||
)
|
||||
|
||||
// TokenEntity is one detected span from a token-classification (NER)
|
||||
// model. Mirrors pb.TokenClassifyEntity but keeps the proto type out of
|
||||
// consumers. Start/End are BYTE offsets into the classified text,
|
||||
// half-open (addressing text[Start:End]) — the proto contract. Group is
|
||||
// the model's entity label (e.g. "private_person", "EMAIL").
|
||||
type TokenEntity struct {
|
||||
Group string `json:"group"`
|
||||
Start int `json:"start"`
|
||||
End int `json:"end"`
|
||||
Score float32 `json:"score"`
|
||||
Text string `json:"text"`
|
||||
}
|
||||
|
||||
// TokenClassifyOptions controls a single TokenClassify request.
|
||||
type TokenClassifyOptions struct {
|
||||
// Threshold drops entities the backend scores below this value at
|
||||
// the source. 0 returns everything the model emits; downstream
|
||||
// callers (e.g. the PII redactor's MinScore) can still filter
|
||||
// further once they know the per-request policy.
|
||||
Threshold float32
|
||||
}
|
||||
|
||||
// TokenClassifier runs a token-classification model over text and
|
||||
// returns the detected entity spans. Implemented by NewTokenClassifier
|
||||
// over a model-loaded backend; the PII redactor's encoder/NER tier
|
||||
// consumes this via a pii.NERDetector adapter (see
|
||||
// core/services/routing/piidetector).
|
||||
type TokenClassifier interface {
|
||||
TokenClassify(ctx context.Context, text string) ([]TokenEntity, error)
|
||||
}
|
||||
|
||||
// NewTokenClassifier binds (loader, modelConfig, appConfig) into a
|
||||
// TokenClassifier. The underlying backend is resolved lazily on the
|
||||
// first call, mirroring NewScorer.
|
||||
func NewTokenClassifier(loader *model.ModelLoader, modelConfig config.ModelConfig, appConfig *config.ApplicationConfig, opts TokenClassifyOptions) TokenClassifier {
|
||||
return &modelTokenClassifier{loader: loader, modelConfig: modelConfig, appConfig: appConfig, opts: opts}
|
||||
}
|
||||
|
||||
type modelTokenClassifier struct {
|
||||
loader *model.ModelLoader
|
||||
modelConfig config.ModelConfig
|
||||
appConfig *config.ApplicationConfig
|
||||
opts TokenClassifyOptions
|
||||
}
|
||||
|
||||
func (m *modelTokenClassifier) TokenClassify(ctx context.Context, text string) ([]TokenEntity, error) {
|
||||
fn, err := ModelTokenClassify(text, m.opts, m.loader, m.modelConfig, m.appConfig)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return fn(ctx)
|
||||
}
|
||||
|
||||
// ModelTokenClassify loads the backend for modelConfig and returns a
|
||||
// closure that classifies `text`. Mirrors ModelScore: the closure is
|
||||
// bound to the loaded model so a caller can reuse it within a request
|
||||
// without re-resolving the backend.
|
||||
//
|
||||
// When tracing is enabled it records a BackendTraceTokenClassify row so the
|
||||
// detector's output — every entity's group, byte range, confidence and the
|
||||
// matched substring — shows in the Traces UI alongside the request it gated.
|
||||
// This is the technical view for debugging false positives (e.g. a phone
|
||||
// number scored as SSN); the persisted PIIEvent keeps only a hash.
|
||||
func ModelTokenClassify(text string, opts TokenClassifyOptions, loader *model.ModelLoader, modelConfig config.ModelConfig, appConfig *config.ApplicationConfig) (func(ctx context.Context) ([]TokenEntity, error), error) {
|
||||
modelOpts := ModelOptions(modelConfig, appConfig)
|
||||
inferenceModel, err := loader.Load(modelOpts...)
|
||||
if err != nil {
|
||||
recordModelLoadFailure(appConfig, modelConfig.Name, modelConfig.Backend, err, nil)
|
||||
return nil, err
|
||||
}
|
||||
return func(ctx context.Context) ([]TokenEntity, error) {
|
||||
var startTime time.Time
|
||||
if appConfig.EnableTracing {
|
||||
trace.InitBackendTracingIfEnabled(appConfig.TracingMaxItems, appConfig.TracingMaxBodyBytes)
|
||||
startTime = time.Now()
|
||||
}
|
||||
resp, err := inferenceModel.TokenClassify(ctx, &pb.TokenClassifyRequest{
|
||||
Text: text,
|
||||
Threshold: opts.Threshold,
|
||||
})
|
||||
entities := tokenClassifyResponseToEntities(resp)
|
||||
if appConfig.EnableTracing {
|
||||
trace.RecordBackendTrace(tokenClassifyTrace(modelConfig, text, opts.Threshold, entities, startTime, err))
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return entities, nil
|
||||
}, nil
|
||||
}
|
||||
|
||||
// tokenClassifyTrace assembles the Traces-UI row for one NER call: the input
|
||||
// preview, the threshold, and every detected entity (group, byte range,
|
||||
// confidence, matched text). Split out from the closure so the Data assembly
|
||||
// is unit-testable without a live backend.
|
||||
func tokenClassifyTrace(modelConfig config.ModelConfig, text string, threshold float32, entities []TokenEntity, start time.Time, callErr error) trace.BackendTrace {
|
||||
errStr := ""
|
||||
if callErr != nil {
|
||||
errStr = callErr.Error()
|
||||
}
|
||||
return trace.BackendTrace{
|
||||
Timestamp: start,
|
||||
Duration: time.Since(start),
|
||||
Type: trace.BackendTraceTokenClassify,
|
||||
ModelName: modelConfig.Name,
|
||||
Backend: modelConfig.Backend,
|
||||
Summary: trace.TruncateString(text, 200),
|
||||
Error: errStr,
|
||||
Data: map[string]any{
|
||||
"input_chars": len(text),
|
||||
"threshold": threshold,
|
||||
"entities": entities,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// tokenClassifyResponseToEntities converts the wire-format response into
|
||||
// the value type consumed by callers. Extracted so the conversion can be
|
||||
// unit-tested without a real backend (see token_classify_test.go).
|
||||
func tokenClassifyResponseToEntities(resp *pb.TokenClassifyResponse) []TokenEntity {
|
||||
if resp == nil {
|
||||
return nil
|
||||
}
|
||||
out := make([]TokenEntity, 0, len(resp.Entities))
|
||||
for _, e := range resp.Entities {
|
||||
if e == nil {
|
||||
continue
|
||||
}
|
||||
out = append(out, TokenEntity{
|
||||
Group: e.EntityGroup,
|
||||
Start: int(e.Start),
|
||||
End: int(e.End),
|
||||
Score: e.Score,
|
||||
Text: e.Text,
|
||||
})
|
||||
}
|
||||
return out
|
||||
}
|
||||
61
core/backend/token_classify_test.go
Normal file
61
core/backend/token_classify_test.go
Normal file
@@ -0,0 +1,61 @@
|
||||
package backend
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"time"
|
||||
|
||||
"github.com/mudler/LocalAI/core/config"
|
||||
"github.com/mudler/LocalAI/core/trace"
|
||||
pb "github.com/mudler/LocalAI/pkg/grpc/proto"
|
||||
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
var _ = Describe("tokenClassifyResponseToEntities", func() {
|
||||
It("returns nil for a nil response", func() {
|
||||
Expect(tokenClassifyResponseToEntities(nil)).To(BeNil())
|
||||
})
|
||||
|
||||
It("maps proto entities to TokenEntity, skipping nil rows", func() {
|
||||
resp := &pb.TokenClassifyResponse{
|
||||
Entities: []*pb.TokenClassifyEntity{
|
||||
{EntityGroup: "private_person", Start: 3, End: 8, Score: 0.97, Text: "Alice"},
|
||||
nil,
|
||||
{EntityGroup: "EMAIL", Start: 20, End: 40, Score: 0.5, Text: "a@b.com"},
|
||||
},
|
||||
}
|
||||
Expect(tokenClassifyResponseToEntities(resp)).To(Equal([]TokenEntity{
|
||||
{Group: "private_person", Start: 3, End: 8, Score: 0.97, Text: "Alice"},
|
||||
{Group: "EMAIL", Start: 20, End: 40, Score: 0.5, Text: "a@b.com"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("returns an empty (non-nil) slice for a response with no entities", func() {
|
||||
out := tokenClassifyResponseToEntities(&pb.TokenClassifyResponse{})
|
||||
Expect(out).NotTo(BeNil())
|
||||
Expect(out).To(BeEmpty())
|
||||
})
|
||||
})
|
||||
|
||||
var _ = Describe("tokenClassifyTrace", func() {
|
||||
cfg := config.ModelConfig{Name: "privacy-filter", Backend: "privacy-filter"}
|
||||
ents := []TokenEntity{{Group: "SSN", Start: 5, End: 16, Score: 0.62, Text: "123-45-6789"}}
|
||||
|
||||
It("captures model, input preview, threshold and per-entity detail", func() {
|
||||
tr := tokenClassifyTrace(cfg, "ssn is 123-45-6789", 0.5, ents, time.Now(), nil)
|
||||
Expect(tr.Type).To(Equal(trace.BackendTraceTokenClassify))
|
||||
Expect(tr.ModelName).To(Equal("privacy-filter"))
|
||||
Expect(tr.Backend).To(Equal("privacy-filter"))
|
||||
Expect(tr.Summary).To(ContainSubstring("ssn is"))
|
||||
Expect(tr.Error).To(BeEmpty())
|
||||
Expect(tr.Data["input_chars"]).To(Equal(len("ssn is 123-45-6789")))
|
||||
Expect(tr.Data["threshold"]).To(BeEquivalentTo(float32(0.5)))
|
||||
Expect(tr.Data["entities"]).To(Equal(ents))
|
||||
})
|
||||
|
||||
It("records the backend error string when the call failed", func() {
|
||||
tr := tokenClassifyTrace(cfg, "x", 0, nil, time.Now(), errors.New("boom"))
|
||||
Expect(tr.Error).To(Equal("boom"))
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user