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

Listen

PreviousCallbackNextRedaction

Last updated 1 year ago

This endpoint is used for accepting incoming rea-time audio streams.

Sample Response

{
    "source": "file",
    "utterance": {
        "donedate": "2023-04-12 19:41:27.328595",
        "text": "Well, we did send out a letter to all our clients notifying of this increase. It was a management decision.",
        "recvtz": [
            "UTC",
            0
        ],
        "confidence": 0.85,
        "end": 80.33,
        "start": 71.81,
        "recvdate": "2023-04-12 19:41:26.141208",
        "metadata": {
            "source": "file",
            "model": "eng-us:callcenter",
            "uttid": 7,
            "channel": 1
        }
    }
}

Accepts real-time callbacks

post

Note this method accepts callbacks from V-Cloud.

POST /live/listen
{
    "confidence": 0.89,
    "donedate": "2019-09-09 15:24:31.532134",
    "emotion": "Positive"
    ...
}
Query parameters
idstringOptional

The id of the call session

statusstringOptional

The status of the operation

programstringOptional

The name of the program to use

outputstringOptional

The output of the transcription results

Body
anyOptional
Responses
200
If incoming json is processed successfully
Responsestring
404
If unable to accept incoming json
500
Internal server error
post
POST /live/listen HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
text