diff --git a/examples/300-spring-boot-live-transcription-java/.env.example b/examples/300-spring-boot-live-transcription-java/.env.example new file mode 100644 index 0000000..99314a3 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/.env.example @@ -0,0 +1,2 @@ +# Deepgram — https://console.deepgram.com/ +DEEPGRAM_API_KEY= diff --git a/examples/300-spring-boot-live-transcription-java/.gitignore b/examples/300-spring-boot-live-transcription-java/.gitignore new file mode 100644 index 0000000..2f7896d --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/.gitignore @@ -0,0 +1 @@ +target/ diff --git a/examples/300-spring-boot-live-transcription-java/.mvn/wrapper/maven-wrapper.properties b/examples/300-spring-boot-live-transcription-java/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..ffcab66 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip diff --git a/examples/300-spring-boot-live-transcription-java/README.md b/examples/300-spring-boot-live-transcription-java/README.md new file mode 100644 index 0000000..4640c6a --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/README.md @@ -0,0 +1,58 @@ +# Spring Boot Real-Time Transcription with Deepgram + +A Spring Boot 3 application that provides a WebSocket endpoint for real-time audio transcription using Deepgram's live STT API (Nova-3). Clients connect via WebSocket, send audio data, and receive live transcription results streamed back in real time. + +## What you'll build + +A Java Spring Boot server that accepts browser WebSocket connections, proxies raw audio to Deepgram's live STT WebSocket, and streams transcription results back to the client. Includes a built-in HTML test page for browser-based microphone capture. + +## Prerequisites + +- Java 17+ +- Maven 3.9+ (or use the included Maven wrapper) +- Deepgram account — [get a free API key](https://console.deepgram.com/) + +## Environment variables + +| Variable | Where to find it | +|----------|-----------------| +| `DEEPGRAM_API_KEY` | [Deepgram console](https://console.deepgram.com/) → Settings → API Keys | + +## Install and run + +```bash +cp .env.example .env +# Edit .env and add your DEEPGRAM_API_KEY + +export $(grep -v '^#' .env | xargs) +./mvnw spring-boot:run +``` + +Then open [http://localhost:8080](http://localhost:8080) in your browser, click **Start**, and speak into your microphone. + +## Key parameters + +| Parameter | Value | Description | +|-----------|-------|-------------| +| `model` | `nova-3` | Deepgram's highest-accuracy transcription model | +| `smartFormat` | `true` | Formats numbers, dates, currencies automatically | +| `interimResults` | `true` | Returns partial results as audio streams in | +| `tag` | `deepgram-examples` | Tags API usage for Deepgram console analytics | + +## How it works + +1. Browser opens a WebSocket connection to `/ws/transcribe` +2. Spring Boot handler opens a corresponding Deepgram live STT WebSocket (Nova-3) +3. Browser captures microphone audio via `getUserMedia`, converts to 16-bit PCM, and sends binary frames +4. Handler forwards raw audio bytes to Deepgram in real time +5. Deepgram returns interim and final transcription results +6. Handler forwards transcript JSON back to the browser +7. On disconnect, handler sends `CloseStream` to Deepgram and cleans up + +## Health check + +Spring Boot Actuator exposes a health endpoint at `GET /actuator/health`. + +## Starter templates + +[deepgram-starters](https://github.com/orgs/deepgram-starters/repositories) diff --git a/examples/300-spring-boot-live-transcription-java/mvnw b/examples/300-spring-boot-live-transcription-java/mvnw new file mode 100755 index 0000000..bd8896b --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/examples/300-spring-boot-live-transcription-java/mvnw.cmd b/examples/300-spring-boot-live-transcription-java/mvnw.cmd new file mode 100644 index 0000000..5761d94 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/examples/300-spring-boot-live-transcription-java/pom.xml b/examples/300-spring-boot-live-transcription-java/pom.xml new file mode 100644 index 0000000..bdbcc85 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/pom.xml @@ -0,0 +1,52 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.4.4 + + + + com.deepgram.example + spring-boot-live-transcription + 1.0.0 + Spring Boot Live Transcription + Real-time audio transcription with Deepgram and Spring Boot WebSocket + + + 17 + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-websocket + + + org.springframework.boot + spring-boot-starter-actuator + + + com.deepgram + deepgram-java-sdk + 0.2.0 + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + diff --git a/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/Application.java b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/Application.java new file mode 100644 index 0000000..1958a74 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/Application.java @@ -0,0 +1,11 @@ +package com.deepgram.example; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/TranscriptionWebSocketHandler.java b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/TranscriptionWebSocketHandler.java new file mode 100644 index 0000000..bf84b8f --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/TranscriptionWebSocketHandler.java @@ -0,0 +1,111 @@ +package com.deepgram.example; + +import com.deepgram.DeepgramClient; +import com.deepgram.resources.listen.v1.types.ListenV1CloseStream; +import com.deepgram.resources.listen.v1.types.ListenV1CloseStreamType; +import com.deepgram.resources.listen.v1.websocket.V1ConnectOptions; +import com.deepgram.resources.listen.v1.websocket.V1WebSocketClient; +import com.deepgram.types.ListenV1Model; +import com.deepgram.types.ListenV1SmartFormat; +import com.deepgram.types.ListenV1InterimResults; +import com.deepgram.types.ListenV1Tag; +import okio.ByteString; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; +import org.springframework.web.socket.BinaryMessage; +import org.springframework.web.socket.CloseStatus; +import org.springframework.web.socket.TextMessage; +import org.springframework.web.socket.WebSocketSession; +import org.springframework.web.socket.handler.BinaryWebSocketHandler; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; + +@Component +public class TranscriptionWebSocketHandler extends BinaryWebSocketHandler { + + private static final Logger log = LoggerFactory.getLogger(TranscriptionWebSocketHandler.class); + + // One Deepgram WebSocket per browser session so each user gets independent transcription + private final Map deepgramClients = new ConcurrentHashMap<>(); + + @Override + public void afterConnectionEstablished(WebSocketSession session) throws Exception { + String apiKey = System.getenv("DEEPGRAM_API_KEY"); + if (apiKey == null || apiKey.isBlank()) { + session.sendMessage(new TextMessage("{\"error\":\"DEEPGRAM_API_KEY not set\"}")); + session.close(CloseStatus.SERVER_ERROR); + return; + } + + DeepgramClient client = DeepgramClient.builder().apiKey(apiKey).build(); + V1WebSocketClient ws = client.listen().v1().v1WebSocket(); + + ws.onResults(result -> { + try { + if (result.getChannel() != null + && result.getChannel().getAlternatives() != null + && !result.getChannel().getAlternatives().isEmpty()) { + String transcript = result.getChannel().getAlternatives().get(0).getTranscript(); + boolean isFinal = result.getIsFinal().orElse(false); + if (transcript != null && !transcript.isEmpty()) { + // Send JSON to the browser: { "transcript": "...", "is_final": true/false } + String json = String.format( + "{\"transcript\":\"%s\",\"is_final\":%b}", + transcript.replace("\"", "\\\""), isFinal); + if (session.isOpen()) { + session.sendMessage(new TextMessage(json)); + } + } + } + } catch (Exception e) { + log.error("Failed to forward transcript to browser", e); + } + }); + + ws.onError(error -> log.error("Deepgram error for session {}: {}", session.getId(), error.getMessage())); + + ws.onDisconnected(reason -> + log.info("Deepgram disconnected for session {} (code={}, reason={})", + session.getId(), reason.getCode(), reason.getReason())); + + // Connect with Nova-3 + smart formatting; tag is REQUIRED for internal tracking + ws.connect(V1ConnectOptions.builder() + .model(ListenV1Model.NOVA3) + .smartFormat(ListenV1SmartFormat.TRUE) + .interimResults(ListenV1InterimResults.TRUE) + .tag(ListenV1Tag.of("deepgram-examples")) // ← REQUIRED: tags usage in Deepgram console + .build() + ).get(10, TimeUnit.SECONDS); + + deepgramClients.put(session.getId(), ws); + log.info("Browser session {} connected — Deepgram WebSocket open", session.getId()); + } + + @Override + protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) { + V1WebSocketClient ws = deepgramClients.get(session.getId()); + if (ws != null) { + // Forward raw audio from the browser straight to Deepgram + ws.sendMedia(ByteString.of(message.getPayload())); + } + } + + @Override + public void afterConnectionClosed(WebSocketSession session, CloseStatus status) { + V1WebSocketClient ws = deepgramClients.remove(session.getId()); + if (ws != null) { + try { + ws.sendCloseStream(ListenV1CloseStream.builder() + .type(ListenV1CloseStreamType.CLOSE_STREAM) + .build()); + } catch (Exception e) { + log.debug("Error sending CloseStream", e); + } + ws.disconnect(); + } + log.info("Browser session {} closed ({})", session.getId(), status); + } +} diff --git a/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/WebSocketConfig.java b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/WebSocketConfig.java new file mode 100644 index 0000000..7c404b7 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/src/main/java/com/deepgram/example/WebSocketConfig.java @@ -0,0 +1,23 @@ +package com.deepgram.example; + +import org.springframework.context.annotation.Configuration; +import org.springframework.web.socket.config.annotation.EnableWebSocket; +import org.springframework.web.socket.config.annotation.WebSocketConfigurer; +import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry; + +@Configuration +@EnableWebSocket +public class WebSocketConfig implements WebSocketConfigurer { + + private final TranscriptionWebSocketHandler transcriptionHandler; + + public WebSocketConfig(TranscriptionWebSocketHandler transcriptionHandler) { + this.transcriptionHandler = transcriptionHandler; + } + + @Override + public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { + // Browser clients connect here to stream audio and receive transcripts + registry.addHandler(transcriptionHandler, "/ws/transcribe").setAllowedOrigins("*"); + } +} diff --git a/examples/300-spring-boot-live-transcription-java/src/main/resources/application.properties b/examples/300-spring-boot-live-transcription-java/src/main/resources/application.properties new file mode 100644 index 0000000..218a713 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/src/main/resources/application.properties @@ -0,0 +1,2 @@ +server.port=8080 +management.endpoints.web.exposure.include=health diff --git a/examples/300-spring-boot-live-transcription-java/src/main/resources/static/index.html b/examples/300-spring-boot-live-transcription-java/src/main/resources/static/index.html new file mode 100644 index 0000000..f341bfd --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/src/main/resources/static/index.html @@ -0,0 +1,117 @@ + + + + + + Deepgram Live Transcription + + + +

Deepgram Live Transcription

+
+ + +
+
Click Start and allow microphone access.
+
+ + + + diff --git a/examples/300-spring-boot-live-transcription-java/tests/test_transcription.java b/examples/300-spring-boot-live-transcription-java/tests/test_transcription.java new file mode 100644 index 0000000..7274e57 --- /dev/null +++ b/examples/300-spring-boot-live-transcription-java/tests/test_transcription.java @@ -0,0 +1,98 @@ +import com.deepgram.DeepgramClient; +import com.deepgram.resources.listen.v1.types.ListenV1CloseStream; +import com.deepgram.resources.listen.v1.types.ListenV1CloseStreamType; +import com.deepgram.resources.listen.v1.websocket.V1ConnectOptions; +import com.deepgram.resources.listen.v1.websocket.V1WebSocketClient; +import com.deepgram.types.ListenV1Model; +import com.deepgram.types.ListenV1Tag; +import okio.ByteString; + +import java.io.IOException; +import java.net.URI; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Arrays; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +public class test_transcription { + + public static void main(String[] args) throws Exception { + // ── Credential check — MUST be first ────────────────────────────────────── + Path envExample = Path.of(System.getProperty("user.dir"), ".env.example"); + if (!Files.exists(envExample)) { + envExample = Path.of(System.getProperty("user.dir"), "..", ".env.example"); + } + java.util.List required = Files.readAllLines(envExample).stream() + .filter(l -> !l.isBlank() && !l.startsWith("#") && l.contains("=")) + .map(l -> l.split("=")[0].trim()) + .toList(); + java.util.List missing = required.stream() + .filter(k -> System.getenv(k) == null || System.getenv(k).isBlank()) + .toList(); + if (!missing.isEmpty()) { + System.err.println("MISSING_CREDENTIALS: " + String.join(",", missing)); + System.exit(2); + } + // ────────────────────────────────────────────────────────────────────────── + + byte[] audio = URI.create("https://dpgr.am/spacewalk.wav").toURL().openStream().readAllBytes(); + + DeepgramClient client = DeepgramClient.builder() + .apiKey(System.getenv("DEEPGRAM_API_KEY")) + .build(); + + V1WebSocketClient ws = client.listen().v1().v1WebSocket(); + + AtomicBoolean gotTranscript = new AtomicBoolean(false); + AtomicReference lastTranscript = new AtomicReference<>(""); + CountDownLatch done = new CountDownLatch(1); + + ws.onResults(result -> { + if (result.getIsFinal().orElse(false) + && result.getChannel() != null + && result.getChannel().getAlternatives() != null + && !result.getChannel().getAlternatives().isEmpty()) { + String t = result.getChannel().getAlternatives().get(0).getTranscript(); + if (t != null && !t.isEmpty()) { + gotTranscript.set(true); + lastTranscript.set(t); + } + } + }); + + ws.onError(e -> { + System.err.println("Deepgram error: " + e.getMessage()); + }); + + ws.onDisconnected(r -> done.countDown()); + + CompletableFuture connectFuture = ws.connect(V1ConnectOptions.builder() + .model(ListenV1Model.NOVA3) + .tag(ListenV1Tag.of("deepgram-examples")) + .build()); + connectFuture.get(10, TimeUnit.SECONDS); + + for (int i = 0; i < audio.length; i += 4096) { + ws.sendMedia(ByteString.of(audio, i, Math.min(4096, audio.length - i))); + } + + ws.sendCloseStream(ListenV1CloseStream.builder() + .type(ListenV1CloseStreamType.CLOSE_STREAM) + .build()); + + done.await(60, TimeUnit.SECONDS); + ws.disconnect(); + + if (!gotTranscript.get()) { + System.err.println("FAIL: No transcript received"); + System.exit(1); + } + + System.out.println("PASS: Received transcript — \"" + lastTranscript.get() + "\""); + System.exit(0); + } +}