# 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.

{% openapi src="<https://503895249-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1EY0mdS3o1Qc94eAkSh5%2Fuploads%2FAqdEPpbXi7C6chaHRJH6%2Fv2_swagger.json?alt=media&token=a27df7fd-d574-4fb7-a088-c52eea2022a5>" path="/system/cache/v2/publish" method="post" fullWidth="false" %}
[v2\_swagger.json](https://503895249-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1EY0mdS3o1Qc94eAkSh5%2Fuploads%2FAqdEPpbXi7C6chaHRJH6%2Fv2_swagger.json?alt=media\&token=a27df7fd-d574-4fb7-a088-c52eea2022a5)
{% endopenapi %}

### 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.

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

### Pause and Resume

<table><thead><tr><th width="297">Name</th><th width="166.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>active</code></td><td><code>boolean</code></td><td>Activates functionality. Default is <code>false</code>.</td></tr><tr><td><code>spotlight</code></td><td><code>boolean</code></td><td>Redacts non confidential data during the operation. Default is <code>false</code>.</td></tr><tr><td><code>pause_insights</code></td><td><code>array[string]</code></td><td>Insights to be used in determining the <code>pause</code> location.</td></tr><tr><td><code>resume_insights</code></td><td><code>array[string]</code></td><td>Insights to be used in determining the <code>resume</code> location.</td></tr><tr><td><code>pause_start</code></td><td><code>boolean</code></td><td>Starts the redaction at the beginning of the utterance where the <code>pause</code> is detected. Default is <code>false</code>.</td></tr><tr><td><code>pause_end</code></td><td><code>boolean</code></td><td>Starts the redaction at the beginning of the utterance where the <code>resume</code> is detected. Default is <code>false</code>.</td></tr></tbody></table>

### Agent Ignore

<table><thead><tr><th width="297.3333333333333">Name</th><th width="167">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>active</code></td><td><code>boolean</code></td><td>Activates functionality. Default is <code>false</code>.</td></tr><tr><td><code>insights</code></td><td><code>array[string]</code></td><td>Insights to be used in determining which confidential data should be ignored by an agent.</td></tr></tbody></table>

### Rules

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

### Insights

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

### Trigger

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

### Response

<table><thead><tr><th width="297.3333333333333">Name</th><th width="176">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>expression</code></td><td><code>string</code></td><td>The expression used to validate the response. </td></tr><tr><td><code>advanced</code></td><td><code>boolean</code></td><td>Enables the use of Redaction Rules within the response. </td></tr><tr><td><code>rules</code></td><td><code>array[string]</code></td><td>If enabled, the list of rules to execute when response is triggered.</td></tr><tr><td><code>before</code></td><td><code>integer</code></td><td>Sets the number of utterances to search before the triggered event.</td></tr><tr><td><code>after</code></td><td><code>integer</code></td><td>Sets the number of utterances to search after the triggered event.</td></tr><tr><td><code>redaction</code></td><td><code>object</code></td><td>Determines how the response is redacted.</td></tr></tbody></table>

### Redaction

<table><thead><tr><th width="297.3333333333333">Name</th><th width="178">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>type</code></td><td><code>string</code></td><td><p>The type of redaction when before/after is set. </p><p></p><p>Enum: "<code>all</code>" "<code>numbers</code>" "<code>words</code>"</p></td></tr><tr><td><code>before</code></td><td><code>integer</code></td><td>Sets the number of numbers/words to redact before the insight.</td></tr><tr><td><code>after</code></td><td><code>integer</code></td><td>Sets the number of numbers/words to redact after the insight.</td></tr><tr><td><code>line</code></td><td><code>boolean</code></td><td>Redact the entire line when enabled. Default is <code>false</code>.</td></tr><tr><td><code>audio</code></td><td><code>boolean</code></td><td>Enables audio redaction. Default is <code>false</code>.</td></tr><tr><td><code>text</code></td><td><code>boolean</code></td><td>Enables text redaction. Default is <code>false</code>.</td></tr></tbody></table>

### Notification

<table><thead><tr><th width="299.3333333333333">Name</th><th width="178">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>active</code></td><td><code>boolean</code></td><td>Activates functionality. Default is <code>false</code>.</td></tr><tr><td><code>message</code></td><td><code>string</code></td><td>The details of the alert. </td></tr><tr><td><code>alert</code></td><td><code>string</code></td><td>The title of the alert. </td></tr><tr><td><code>notifications</code></td><td><code>boolean</code></td><td>Activates callback. Default is <code>false</code>.</td></tr></tbody></table>

### Substitutions

<table><thead><tr><th width="300.3333333333333">Name</th><th width="175">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code> required</td><td><code>string</code></td><td>The of the substitution. </td></tr><tr><td><code>expression</code></td><td><code>string</code></td><td>The expression used to trigger the substitution. </td></tr><tr><td><code>type</code></td><td><code>string</code></td><td><p>The type of redaction when before/after is set. </p><p></p><p>Enum: "<code>phrase</code>" "<code>expression</code>" "<code>pattern</code>"</p></td></tr><tr><td><code>group</code></td><td><code>string</code></td><td>The group to assign the substitution to. </td></tr><tr><td><code>active</code></td><td><code>boolean</code></td><td>Activates functionality. Default is <code>false</code>.</td></tr><tr><td><code>ignore</code></td><td><code>boolean</code></td><td>When enabled, the substitution will be ignored during redaction. Default is <code>false</code>.</td></tr><tr><td><code>real_time</code></td><td><code>boolean</code></td><td>Enables the substitution for real time processing. Default is <code>false</code>.</td></tr></tbody></table>