BrainEngine AI
  • Welcome
  • Quick Start
    • Introduction
    • Platform Configuration
    • Validate Connectivity
    • Configure Redaction
    • Update Configuration
    • Advanced Redaction
  • Concepts
    • What is Conversational Redaction?
    • Redaction Strategy
    • Understanding Redaction
    • Navigating Utterances
      • Walk through
    • Redaction Techniques
      • Behavior
      • Confidence
      • Mask Types
        • Basic
        • Placeholder
        • Random
        • Truncate
        • Anonymization
      • Redaction Options
    • Insights
      • Insights
      • Query Syntax
      • Advance Processing
      • Simulated Pause & Resume
      • Real-Time Alerts
      • Agent Ignore
      • Offsets
      • Redaction Options
  • Features
    • Overview
    • Entities
      • PII
        • Name
        • Occupation
        • Phone Number
        • Organization
        • Address
        • Email
        • Location
        • Url
        • IP Address
        • Date
        • Age
        • Social Security Number
        • Drivers License
        • Passport
        • Id
        • Money
        • Time
        • User Name
        • Password
      • PHI
        • Medical Condition
        • Medication
        • Family Relation
        • Treatment
        • Examination
        • Anatomy
        • Medical Other
        • Demographic
        • Medical Event
      • PCI
        • Credit Card
        • Credit Card CVV
        • Credit Card Expiry
        • Routing Number
        • Bank Account
      • Custom
        • Dictionary
        • Identifier
        • Custom NER
    • Summarization
    • Sentiment Analysis
    • Topic Extraction
    • Profanity Filtering
  • Configuration
    • Project Configuration
    • Redaction Configuration
    • Samples
      • Configurations
      • Calls
  • Integration
    • V-Blaze
    • V-Spark
    • Analytics
      • Embedded
      • Callback
  • API Guide
    • Overview
      • Errors
      • Getting Help
    • Endpoints
      • ASR
        • Transcribe
        • Maxstreamscheck
        • Languages
        • Models
        • Params
        • Stats
        • Status
        • Sysinfo
        • Statusfull
      • Live
        • Callback
        • Listen
      • Redaction
        • Types
        • Validate
      • System
        • Initialize
        • Set parameter
        • Get parameter
        • Cache
          • List
          • Real time
          • Post call
          • Version 2
            • Publish
            • List
        • Get Settings
      • Status
        • Health
        • Webhooks
  • Deployment
    • Overview
    • Virtual Appliance
      • BrainEngine AMIs
        • Finding AMIs
        • Launching AMIs
        • Connecting to an Instance
        • SSL Configuration
        • Networking (optional)
    • Containers
      • Details
      • Deployment
    • Environment Parameters
    • Logging
  • Support
    • Release Notes
Powered by GitBook
On this page
  1. API Guide
  2. Endpoints
  3. System
  4. Cache

Real time

PreviousListNextPost call

Last updated 1 year ago

Sample Response

{
  "success": true,
  "message": "Cache updated successfully",
  "detail": ""
}

Sets the real-time cache

post
Body
totalCountinteger ยท int32Optional
Responses
200
Cache published successfully
404
Unable to publish cache
500
Internal server error
post
POST /system/cache/real-time HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 6828

{
  "totalCount": 1,
  "items": [
    {
      "campaign": {
        "name": "text",
        "active": true,
        "description": "text",
        "enableAudioRedaction": true,
        "enableTextRedaction": true,
        "enableInsights": true,
        "externalId": "text",
        "enableSentimentAnalysis": true,
        "enableEmotionalAnalysis": true,
        "enablePersonalityAnalysis": true,
        "enableNotifications": true,
        "enableAdvancedMetrics": true,
        "priority": "text",
        "diarization": "text",
        "direction": "text",
        "speakerChangeSensitivity": 1,
        "channelDiarizationLabels": "text",
        "punctuationOverrides": "text",
        "callback": "text",
        "isDeleted": true,
        "isDefault": true,
        "id": "text",
        "enableEntityExtraction": true,
        "enableKeywords": true,
        "enableCategorization": true,
        "enableSemanticSimilarity": true,
        "enableIntentions": true,
        "enableProfanityFiltering": true,
        "enableGenderDetection": true,
        "enableCustomVocabulary": true,
        "enableAutoDelete": true,
        "enableNumeralConversion": true,
        "enableRealTime": true,
        "webhook": "text",
        "headers": "text",
        "appId": "text",
        "appKey": "text",
        "appSecret": "text",
        "eventId": "text",
        "doHippa": true,
        "doMedical": true,
        "settings": {
          "entityEngine": 0,
          "emotionEngine": 0,
          "categoryEngine": 0,
          "hippaEngine": 0,
          "intentEngine": 0,
          "phrasesEngine": 0,
          "piiEngine": 0,
          "sentimentEngine": 0,
          "endpoint": "text",
          "apiKey": "text",
          "secretKey": "text",
          "apiKeyAWS": "text",
          "secretKeyAWS": "text",
          "region": "text",
          "bucket": "text",
          "folder": "text",
          "feature1": "text",
          "feature2": "text",
          "feature3": "text",
          "feature4": "text",
          "feature5": "text",
          "flag1": true,
          "flag2": true,
          "flag3": true,
          "flag4": true,
          "flag5": true
        },
        "enableGenesysSupport": true,
        "accessUrl": "text",
        "folder": "text",
        "acessKey": "text",
        "secretKey": "text",
        "retentionPolicy": 1,
        "featureFlag1": true,
        "featureFlag2": true,
        "featureFlag3": true,
        "featureFlag4": true,
        "featureFlag5": true,
        "feature1": "text",
        "feature2": "text",
        "feature3": "text",
        "feature4": "text",
        "feature5": "text",
        "setting1": "text",
        "setting2": "text",
        "setting3": "text",
        "setting4": "text",
        "setting5": "text",
        "settingFlag1": true,
        "settingFlag2": true,
        "settingFlag3": true,
        "settingFlag4": true,
        "settingFlag5": true,
        "platform1": "text",
        "platform2": "text",
        "platform3": "text",
        "platform4": "text",
        "platform5": "text",
        "platformFlag1": true,
        "platformFlag2": true,
        "platformFlag3": true,
        "platformFlag4": true,
        "platformFlag5": true,
        "setting6": "text",
        "setting7": "text",
        "setting8": "text",
        "setting9": "text",
        "setting10": "text",
        "settingFlag7": true,
        "settingFlag6": true,
        "settingFlag8": true,
        "settingFlag9": true,
        "settingFlag10": true
      },
      "account": {
        "name": "text",
        "active": true,
        "externalId": "text",
        "enableAudioRedaction": true,
        "enableTextRedaction": true,
        "enableSentimentAnalysis": true,
        "enableEmotionalAnalysis": true,
        "enablePersonalityAnalysis": true,
        "enableNotifications": true,
        "enableAdvancedMetrics": true,
        "enableInsights": true,
        "isDeleted": true,
        "id": "text",
        "enableEntityExtraction": true,
        "enableKeywords": true,
        "enableCategorization": true,
        "enableSemanticSimilarity": true,
        "enableIntentions": true,
        "enableProfanityFiltering": true,
        "enableGenderDetection": true,
        "enableCustomVocabulary": true,
        "enableAutoDelete": true,
        "enableNumeralConversion": true,
        "enableRealTime": true
      },
      "engine": {
        "name": "text",
        "active": true,
        "isDefault": true,
        "url": "text",
        "token": "text",
        "description": "text",
        "isDeleted": true,
        "type": "text",
        "callback": "text",
        "queueSize": 1,
        "queuePollingInterval": 1,
        "cleanupPollingInterval": 1,
        "cleanupTimespan": 1,
        "monitorPollingInterval": 1,
        "monitorTimespan": 1,
        "id": "text"
      },
      "definition": {
        "id": "text",
        "name": "text",
        "description": "text",
        "smDiarization": "text",
        "smSpeakerChangeSensitivity": 1,
        "smChannelDiarizationLabels": "text",
        "smPunctuationOverrides": "text",
        "secondaryCallback": "text",
        "vcallbackurl": true,
        "vmodel": "text",
        "token": "text",
        "vnumtrans": "text",
        "vpunctuate": true,
        "vzpass": "text",
        "vzpassout": "text",
        "vemotion": true,
        "vgender": true,
        "vsubst": "text",
        "vsubstinfo": true,
        "vdiarize": "text",
        "vtranscode": true,
        "vcallbackfmt": "text",
        "vcallbackerror": "text",
        "callback": "text",
        "vcallbackredaction": "text",
        "engineType": "text",
        "voutput": "text",
        "voutzip": "text",
        "agentLocation": "text",
        "engineId": "text",
        "vsubstrules": "text",
        "vhints": "text",
        "vrawemotion": true,
        "vrawevents": true,
        "vsentilist": "text",
        "vactivitylevel": 1,
        "vuttmaxgap": 1,
        "vuttmaxsilence": 1,
        "vuttminactivity": 1,
        "vuttpadding": 1,
        "vvadtype": "text",
        "vagentid": true,
        "vinsecure": true,
        "vmusic": true,
        "voutstream": true,
        "vtextinfo": true,
        "vzip": true,
        "vutterancecallback": "text",
        "vutterancefmt": true,
        "vxa": true,
        "vServerType": "text",
        "vsentirules": "text",
        "vdatahdr": "text",
        "vencoding": "text",
        "vendian": "text",
        "vnchannels": 1,
        "vsamprate": 1,
        "vsampwidth": 1
      },
      "languagePack": {
        "name": "text",
        "active": true,
        "isoCode": "text",
        "isDeleted": true,
        "id": "text"
      },
      "outputLocale": {
        "name": "text",
        "active": true,
        "isoCode": "text",
        "isDeleted": true,
        "id": "text"
      },
      "contentGroups": [
        {
          "name": "text",
          "active": true,
          "isDeleted": true,
          "id": "text",
          "contentItems": [
            {
              "value": "text",
              "active": true,
              "itemType": 1,
              "typeName": "text",
              "contentId": "text",
              "isDeleted": true,
              "id": "text",
              "ignore": true
            }
          ]
        }
      ],
      "redactionTypes": [
        {
          "name": "text",
          "active": true,
          "category": "text",
          "isDeleted": true,
          "id": "text",
          "rules": [
            {
              "value": "text",
              "active": true,
              "redactLine": true,
              "type": "text",
              "confidence": 1,
              "typeId": "text",
              "maskType": "text",
              "setting": "text",
              "contentId": "text",
              "language": "text",
              "isDeleted": true,
              "id": "text",
              "redactBefore": 1,
              "redactAfter": 1
            }
          ]
        }
      ],
      "insights": [
        {
          "id": "text",
          "name": "text",
          "label": "text",
          "active": true,
          "direction": 0,
          "channel": 0,
          "leg": 0,
          "description": "text",
          "expression": "text",
          "response": "text",
          "expressionValidated": true,
          "responseValidated": true,
          "sampleExpression": "text",
          "sampleResponse": "text",
          "background": "text",
          "color": "text",
          "icon": "text",
          "recordType": 0,
          "sentiment": 0,
          "gender": 0,
          "maskCharacter": "text",
          "searchLinesBefore": 1,
          "searchLinesAfter": 1,
          "redactAudio": true,
          "redactText": true,
          "enableResponse": true,
          "interfaceGroup": "text",
          "interfaceLanguage": "text",
          "insightGroupId": "123e4567-e89b-12d3-a456-426614174000",
          "languagePackId": "123e4567-e89b-12d3-a456-426614174000",
          "redactBefore": 1,
          "redactAfter": 1,
          "redactionTypes": "text",
          "redactBeforeResponse": 1,
          "redactAfterResponse": 1,
          "redactInput": true,
          "redactResponse": true,
          "redactionTypesResponse": "text",
          "redactLine": true,
          "redactLineResponse": true,
          "redactAudioResponse": true,
          "redactTextResponse": true,
          "redactionType": 0,
          "redactionTypeResponse": 0,
          "sentimentResponse": 0,
          "genderResponse": 0,
          "prompt": "text",
          "alert": true,
          "alertMessage": "text",
          "enableStartOffset": true,
          "enableEndOffset": true,
          "startOffset": 1,
          "endOffset": 1,
          "startLocation": "text",
          "endLocation": "text",
          "advanceProcessing": true,
          "advanceProcessingResponse": true,
          "realTime": true,
          "complianceViolation": true
        }
      ]
    }
  ],
  "settings": {
    "entityEngine": 0,
    "emotionEngine": 0,
    "categoryEngine": 0,
    "hippaEngine": 0,
    "intentEngine": 0,
    "phrasesEngine": 0,
    "piiEngine": 0,
    "sentimentEngine": 0,
    "endpoint": "text",
    "apiKey": "text",
    "secretKey": "text",
    "apiKeyAWS": "text",
    "secretKeyAWS": "text",
    "region": "text",
    "bucket": "text",
    "folder": "text",
    "feature1": "text",
    "feature2": "text",
    "feature3": "text",
    "feature4": "text",
    "feature5": "text",
    "flag1": true,
    "flag2": true,
    "flag3": true,
    "flag4": true,
    "flag5": true
  }
}

No content