Configure Redaction

Learn how to define and publish a BrainEngine project.

Create Project

To protect sensitive data, a project needs to be configured in order to redact the defined entities for a given audio file.

For this example, we will redact the following entities:

• Person

{
    "sid": "NER000",
    "name": "ner",
    "active": true,
    "agent_location": "left",
    "inbound": true,
    "scrubaudio": true,
    "scrubtext": true,
    "rules": [
        {
            "name": "Person",
            "active": true,
            "mask_type": "Placeholder",
            "setting": "[NAME]",
            "real_time": true
        }
    ]
}

Publish Redaction Project

Publish the configuration.

POST /system/cache/v2/publish

Sets the system cache

Request Body

Name	Type	Description
data*	String	Project configuration

200: OK Project published successfully

400: Bad Request Unable to publish project

500: Internal Server Error Internal server error

The example below use cURL, a command line utility that sends HTTP client requests. The cURLapplication is freely available for Linux, Windows, and macOS operating systems.

curl -s -X POST \
-f 'project.json' \
'brainengine_name/system/cache/v2/publish'    

Expected Response

{
  "success": true,
  "message": "",
  "detail": ""
}

Confirm Project Configuration

Open your browser and make a call to the following endpoint using the project sid below to retrieve the published configuration.

sid = NER000

Retrieves the requested project from the cache

get

Query parameters

sidstringOptional

The character string that uniquely identifies the project.

typestringOptional

The type of project. Options: 'realtime' or 'batch'

Default: realtime

Responses

200

Returns the project cache information

404

Unable to return cache for the selected project

500

Internal server error

get

/system/cache

HTTPcURLJavaScriptPython

GET /system/cache HTTP/1.1
Host: 
Accept: */*

No content

curl -s -X POST \
-f 'project.json' \
'brainengine_name/system/cache/v2/publish'

Expected Response

{
    "sid": "NER000",
    "name": "ner",
    "active": true,
    "agent_location": "left",
    "inbound": true,
    "scrubaudio": true,
    "scrubtext": true,
    "rules": [
        {
            "name": "Person",
            "active": true,
            "mask_type": "Placeholder",
            "setting": "[NAME]",
            "real_time": true
        }
    ]
}

Resubmit Sample Call

The example below submits a transcription request to BrainEngine for redaction.

curl -s -X POST \
-T 'sample_2.wav' \
'brainengine_name/transcribe?sid=NER000@scrubtext=true&output=text'

Expected Response

AGENT: Hello. This is [NAME] welcome to that until this is [NAME] from the customer service department how can I be of help.
CLIENT: Hi, [NAME], my name is [NAME] and I am a little bit confused about something that I saw on my account.
AGENT: Who [NAME] just hold on I need to ask you a few security questions for verification.
CLIENT: Okay.
AGENT: Okay. What is your full name please?
CLIENT: [NAME]  .
AGENT: to the to ours
CLIENT: One or.
AGENT: one our okay and your social security number.
CLIENT: 657080021.
AGENT: And current address please.
CLIENT: 11 north Pennsylvania avenue Morris Seville Tennessee.
....