Project Configuration

Overview

BrainEngine necessitates minimal configuration requirements and offers various additional configuration options. This topic outlines both the mandatory and optional configuration adjustments available for utilization in your instance.

Sets the system cache

post

Body

application/jsontext/jsonapplication/*+json

sidstring | nullableOptional

namestring | nullableOptional

descriptionstring | nullableOptional

activebooleanOptional

defaultbooleanOptional

diarizationstring | nullableOptional

agent_locationstring | nullableOptional

inboundbooleanOptional

scrubaudiobooleanOptional

scrubtextbooleanOptional

ignorestring | nullableOptional

behaviorstring | nullableOptional

confidencestring | nullableOptional

real_timebooleanOptional

health_enabledbooleanOptional

callbackstring | nullableOptional

headersstring | nullableOptional

Responses

200

Project published successfully

404

Unable to publish project

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /system/cache/v2/publish HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1623

{
  "sid": "text",
  "name": "text",
  "description": "text",
  "active": true,
  "default": true,
  "diarization": "text",
  "agent_location": "text",
  "inbound": true,
  "scrubaudio": true,
  "scrubtext": true,
  "ignore": "text",
  "behavior": "text",
  "confidence": "text",
  "real_time": true,
  "health_enabled": true,
  "callback": "text",
  "headers": "text",
  "pause_resume": {
    "active": true,
    "spotlight": true,
    "pause_insights": [
      "text"
    ],
    "resume_insights": [
      "text"
    ],
    "pause_start": true,
    "resume_start": true
  },
  "agent_ignore": {
    "active": true,
    "insights": [
      "text"
    ]
  },
  "rules": [
    {
      "name": "text",
      "type": "text",
      "langugage": "text",
      "description": "text",
      "regex": "text",
      "repl": "text",
      "text": true,
      "report": true,
      "audio": true,
      "start": true,
      "stop": true,
      "agentignore": true,
      "score": 1,
      "mask_type": "text",
      "setting": "text",
      "substitutions": [
        "text"
      ],
      "before": 1,
      "after": 1,
      "active": true,
      "line": true,
      "real_time": true
    }
  ],
  "insights": [
    {
      "name": "text",
      "label": "text",
      "active": true,
      "description": "text",
      "leg": "text",
      "model": "text",
      "validation": true,
      "compliance": true,
      "real_time": true,
      "trigger": {
        "expression": "text",
        "offset_start": true,
        "offset_end": true,
        "position_start": "text",
        "position_end": "text",
        "secs_start": 1,
        "secs_end": 1,
        "advanced": true,
        "rules": [
          "text"
        ],
        "redaction": {
          "type": "text",
          "before": 1,
          "after": 1,
          "line": true,
          "audio": true,
          "text": true
        }
      },
      "response": {
        "expression": "text",
        "advanced": true,
        "rules": [
          "text"
        ],
        "before": 1,
        "after": 1,
        "redaction": {
          "type": "text",
          "before": 1,
          "after": 1,
          "line": true,
          "audio": true,
          "text": true
        }
      },
      "realtime": {
        "active": true,
        "message": "text",
        "alert": "text",
        "notifications": true
      }
    }
  ],
  "substitutions": [
    {
      "name": "text",
      "expression": "text",
      "type": "text",
      "group": "text",
      "active": true,
      "ignore": true,
      "real_time": true
    }
  ]
}

application/jsontext/jsonapplication/*+json

No content

Project Parameters

Below are the project runtime parameters. The parameter syntax includes both the implied value and the default value, as appropriate. Optional arguments are enclosed in square brackets, while implied and default values are specified within parentheses.

Name	Type	Description
sid required	string	The unique string identify for the project.
name required	string	The name of the project.
active	boolean	If the project is active. Default is false.
inbound	boolean	Sets the type of call direction for the project.
scrubaudio	boolean	Enables audio redaction. Default is false.
scrubtext	boolean	Enables text redaction. Default is false.
default	boolean	If the project is to be used as the default project.
diarization	string	Sets the type of calls to process. Select either speaker (single-channel) or channel (two-channel) audio. Default is channel. Enum: "speaker" "channel"
agent_location	string	Select the audio channel for agent speech. Enum: "left" "right"
ignore	string	Reserved for future use.
behavior	string	Sets the level of redaction. Enum: "default" "conservative" "moderate" "aggressive" Click here to learn more.
confidence	string	Sets the scoring threshold. Enum: "default" "low" "medium" "high" Click here to learn more.
format	string	Sets the formatting of the redactions within the transcription JSON. Sample: My name is Johnathan Jones Default: My name is [NAME] Raw: My name is [NAME]*** ***** Enum: "default" "raw"
real_time	boolean	Enables the project for real time redaction. Default is false.
health_enabled	boolean	Enables the project for medical and health redaction. Default is false.
callback	string	The URL to which BrainEngine will POST analytics.
headers	string	A list of additional headers to be added to the callback request when using http or https.
analytics	boolean	Enables conversational analytics. Default is none. Enum: "none" "embedded" "callback"
pause_resume	object	Sets the Pause & Resume functionality for the project.
agent_ignore	object	Sets the insights to be ignore by the agent.
rules	array[object]	Sets the redaction functionality for the project.
insights	array[object]	Sets the advanced redaction functionality for the project.
substitutions	array[object]	Sets the substitutions functionality for the project.

Pause and Resume

Name	Type	Description
active	boolean	Activates functionality. Default is false.
spotlight	boolean	Redacts non confidential data during the operation. Default is false.
pause_insights	array[string]	Insights to be used in determining the pause location.
resume_insights	array[string]	Insights to be used in determining the resume location.
pause_start	boolean	Starts the redaction at the beginning of the utterance where the pause is detected. Default is false.
pause_end	boolean	Starts the redaction at the beginning of the utterance where the resume is detected. Default is false.

Agent Ignore

Name	Type	Description
active	boolean	Activates functionality. Default is false.
insights	array[string]	Insights to be used in determining which confidential data should be ignored by an agent.

Rules

Name	Type	Description
name	string	The user friendly name of the rule.
type	string	The type of entity to use.
language	string	The language to be used. Default is en.
description	string	The description of the rule.
regex	string	A regular expression for the rule.
repl	string	The value to apply to the rule.
text	string	Enables text redaction. Default is false.
report	boolean	Enables reporting. Default is false.
audio	boolean	Enables audio redaction. Default is false.
start	boolean	Reserved for future use.
stop	boolean	Reserved for future use.
agent_ignore	boolean	Determines if the rule is used for Agent Ignore functionality. Default is false.
score	integer	The score used to trigger the rule. Default is 0.
mask_type	string	Defines how the the sensitive data is to be redacted. Enum: "basic" "placeholder" "substitution" "random" "truncate"
setting	string	Defines how the redacted data will be presented.
substitutions	array[string]	A list of values to be used or ignored during redaction.
before	integer	Redact the specified number of words before the identified text. Default is 0.
after	integer	Redact the specified number of words before the identified text. Default is 0.
active	boolean	Activates functionality. Default is false.
line	boolean	Redacts the entire utterance when rule is triggered. Default is false.
real_time	boolean	Enables the rule for real time processing. Default is false.

Insights

Name	Type	Description
name required	string	The name of the insight.
label	string	The value displayed for redaction. If blank, the name will be used.
active	boolean	Activates functionality. Default is false.
description	string	Description for the insight.
leg	string	Defines the leg of the conversation on where the insight is executed. Enum: "both" "agent" "caller"
model	string	The language model to be used.
validation	string	Enables response validation. Default is false.
compliance	boolean	When invoked, the insight triggers a compliance violation.
real_time	boolean	Enables the insight for real time processing. Default is false.
trigger	Trigger	Defines when the insight is triggered.
response	Response	Defines how the response is validated.
notification	object	Defines the alert notification parameters.

Trigger

Name	Type	Description
expression	string	The expression used to trigger the insight.
offset_start	boolean	If enabled, compares the insight's timestamp to the specified offset.
offset_end	boolean	If enabled, compares the insight's timestamp to the specified offset.
position_start	string	Where in the call should the start position be triggered. Enum: "inside" "outside"
position_end	string	Where in the call should the end position be triggered. Enum: "inside" "outside"
secs_start	integer	The number of seconds for the offset.
secs_end	integer	The number of seconds for the offset.
advanced	boolean	Enables the use of Redaction Rules within the insight.
rules	array[string]	If enabled, the list of rules to execute when triggered.
redaction	object	Determines how the trigger is redacted.

Response

Name	Type	Description
expression	string	The expression used to validate the response.
advanced	boolean	Enables the use of Redaction Rules within the response.
rules	array[string]	If enabled, the list of rules to execute when response is triggered.
before	integer	Sets the number of utterances to search before the triggered event.
after	integer	Sets the number of utterances to search after the triggered event.
redaction	object	Determines how the response is redacted.

Redaction

Name	Type	Description
type	string	The type of redaction when before/after is set. Enum: "all" "numbers" "words"
before	integer	Sets the number of numbers/words to redact before the insight.
after	integer	Sets the number of numbers/words to redact after the insight.
line	boolean	Redact the entire line when enabled. Default is false.
audio	boolean	Enables audio redaction. Default is false.
text	boolean	Enables text redaction. Default is false.

Notification

Name	Type	Description
active	boolean	Activates functionality. Default is false.
message	string	The details of the alert.
alert	string	The title of the alert.
notifications	boolean	Activates callback. Default is false.

Substitutions

Name	Type	Description
name required	string	The of the substitution.
expression	string	The expression used to trigger the substitution.
type	string	The type of redaction when before/after is set. Enum: "phrase" "expression" "pattern"
group	string	The group to assign the substitution to.
active	boolean	Activates functionality. Default is false.
ignore	boolean	When enabled, the substitution will be ignored during redaction. Default is false.
real_time	boolean	Enables the substitution for real time processing. Default is false.