Add Java and Kotlin API for Cohere Transcribe (#3461)

csukuangfj · web-flow · commit 99206ad98d83 · 2026-04-03T10:53:23.000+08:00
This pull request introduces support for the Cohere Transcribe model across the Java and Kotlin APIs. Key changes include the addition of the OfflineCohereTranscribeModelConfig class, updated JNI bindings to handle the new configuration, and new example scripts and source files for both languages.
diff --git a/.github/workflows/jni.yaml b/.github/workflows/jni.yaml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - jni
       - kotlin
     paths:
       - '.github/workflows/jni.yaml'
diff --git a/.github/workflows/run-java-test.yaml b/.github/workflows/run-java-test.yaml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - jni
       - java
     paths:
       - '.github/workflows/run-java-test.yaml'
@@ -109,6 +110,13 @@ jobs:
           cd ./java-api-examples
           ./run-version-test.sh
 
+      - name:  Run java test (Cohere Transcribe)
+        shell: bash
+        run: |
+          cd ./java-api-examples
+          ./run-non-streaming-decode-file-cohere-transcribe.sh
+          rm -rf sherpa-onnx-cohere-transcribe-*
+
       - name:  Run java test (Qwen3 ASR)
         if: matrix.os != 'ubuntu-latest'
         shell: bash
diff --git a/java-api-examples/NonStreamingDecodeFileCohereTranscribe.java b/java-api-examples/NonStreamingDecodeFileCohereTranscribe.java
@@ -0,0 +1,63 @@
+// Copyright 2026 Xiaomi Corporation
+
+// This file shows how to use an offline Cohere Transcribe model
+// to decode files.
+import com.k2fsa.sherpa.onnx.*;
+
+public class NonStreamingDecodeFileCohereTranscribe {
+  public static void main(String[] args) {
+    String modelDir = "./sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01";
+    String encoder = modelDir + "/encoder.int8.onnx";
+    String decoder = modelDir + "/decoder.int8.onnx";
+    String tokens = modelDir + "/tokens.txt";
+
+    String waveFilename = modelDir + "/test_wavs/en.wav";
+
+    WaveReader reader = new WaveReader(waveFilename);
+
+    OfflineCohereTranscribeModelConfig cohereTranscribe =
+        OfflineCohereTranscribeModelConfig.builder()
+            .setEncoder(encoder)
+            .setDecoder(decoder)
+            .setUsePunct(true)
+            .setUseItn(true)
+            .build();
+
+    OfflineModelConfig modelConfig =
+        OfflineModelConfig.builder()
+            .setCohereTranscribe(cohereTranscribe)
+            .setTokens(tokens)
+            .setNumThreads(2)
+            .setDebug(true)
+            .build();
+
+    OfflineRecognizerConfig config =
+        OfflineRecognizerConfig.builder()
+            .setOfflineModelConfig(modelConfig)
+            .setDecodingMethod("greedy_search")
+            .build();
+
+    OfflineRecognizer recognizer = new OfflineRecognizer(config);
+    OfflineStream stream = recognizer.createStream();
+    stream.setOption("language", "en");
+    stream.acceptWaveform(reader.getSamples(), reader.getSampleRate());
+
+    long start = System.currentTimeMillis();
+    recognizer.decode(stream);
+    long stop = System.currentTimeMillis();
+
+    String text = recognizer.getResult(stream).getText();
+
+    float timeElapsedSeconds = (stop - start) / 1000.0f;
+    float audioDuration = reader.getSamples().length / (float) reader.getSampleRate();
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
+
+    System.out.printf("filename:%s\nresult:%s\n", waveFilename, text);
+    System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
+    System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
+
+    stream.release();
+    recognizer.release();
+  }
+}
diff --git a/java-api-examples/run-non-streaming-decode-file-cohere-transcribe.sh b/java-api-examples/run-non-streaming-decode-file-cohere-transcribe.sh
@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+set -ex
+
+if [[ ! -f ../build/lib/libsherpa-onnx-jni.dylib  && ! -f ../build/lib/libsherpa-onnx-jni.so ]]; then
+  mkdir -p ../build
+  pushd ../build
+  cmake \
+    -DSHERPA_ONNX_ENABLE_PYTHON=OFF \
+    -DSHERPA_ONNX_ENABLE_TESTS=OFF \
+    -DSHERPA_ONNX_ENABLE_CHECK=OFF \
+    -DBUILD_SHARED_LIBS=ON \
+    -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
+    -DSHERPA_ONNX_ENABLE_JNI=ON \
+    ..
+
+  make -j4
+  ls -lh lib
+  popd
+fi
+
+if [ ! -f ../sherpa-onnx/java-api/build/sherpa-onnx.jar ]; then
+  pushd ../sherpa-onnx/java-api
+  make
+  popd
+fi
+
+if [ ! -f ./sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01/encoder.int8.onnx ]; then
+  curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+  tar xvf sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+  rm sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+  ls -lh sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01
+fi
+
+java \
+  -Djava.library.path=$PWD/../build/lib \
+  -cp ../sherpa-onnx/java-api/build/sherpa-onnx.jar \
+  NonStreamingDecodeFileCohereTranscribe.java
diff --git a/kotlin-api-examples/run.sh b/kotlin-api-examples/run.sh
@@ -737,6 +737,28 @@ function testOfflineQwen3Asr() {
   java -Djava.library.path=../build/lib -jar $out_filename
 }
 
+function testOfflineCohereTranscribe() {
+  if [ ! -f ./sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01/encoder.int8.onnx ]; then
+    curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+    tar xvf sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+    rm sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01.tar.bz2
+  fi
+
+  out_filename=test_offline_cohere_transcribe.jar
+  kotlinc-jvm -include-runtime -d $out_filename \
+    test_offline_cohere_transcribe.kt \
+    FeatureConfig.kt \
+    QnnConfig.kt \
+    HomophoneReplacerConfig.kt \
+    OfflineRecognizer.kt \
+    OfflineStream.kt \
+    WaveReader.kt \
+    faked-asset-manager.kt
+
+  ls -lh $out_filename
+  java -Djava.library.path=../build/lib -jar $out_filename
+}
+
 function testOfflineWenetCtc() {
   if [ ! -f sherpa-onnx-wenetspeech-yue-u2pp-conformer-ctc-zh-en-cantonese-int8-2025-09-10/model.int8.onnx ]; then
     curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-wenetspeech-yue-u2pp-conformer-ctc-zh-en-cantonese-int8-2025-09-10.tar.bz2
@@ -760,6 +782,7 @@ function testOfflineWenetCtc() {
 }
 
 testVersion
+testOfflineCohereTranscribe
 testOfflineQwen3Asr
 testOfflineMoonshineAsrV2
 testOfflineFireRedAsrCtc
diff --git a/kotlin-api-examples/test_offline_cohere_transcribe.kt b/kotlin-api-examples/test_offline_cohere_transcribe.kt
@@ -0,0 +1,54 @@
+package com.k2fsa.sherpa.onnx
+
+fun main() {
+  val recognizer = createOfflineRecognizer()
+  val waveFilename = "./sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01/test_wavs/en.wav"
+
+  val waveData = WaveReader.readWaveFromFile(
+      filename = waveFilename,
+  )
+
+  val stream = recognizer.createStream()
+  stream.setOption("language", "en")
+  stream.acceptWaveform(waveData.samples, sampleRate=waveData.sampleRate)
+
+  val start = System.currentTimeMillis()
+  recognizer.decode(stream)
+  val stop = System.currentTimeMillis()
+
+  val result = recognizer.getResult(stream)
+  println(result)
+
+  val timeElapsedSeconds = (stop - start) / 1000.0f
+  val audioDuration = waveData.samples.size / waveData.sampleRate.toFloat()
+  val realTimeFactor = timeElapsedSeconds / audioDuration
+
+  println(String.format("-- elapsed : %.3f seconds", timeElapsedSeconds))
+  println(String.format("-- audio duration: %.3f seconds", audioDuration))
+  println(String.format("-- real-time factor (RTF): %.3f", realTimeFactor))
+
+  stream.release()
+  recognizer.release()
+}
+
+
+fun createOfflineRecognizer(): OfflineRecognizer {
+  val modelDir = "./sherpa-onnx-cohere-transcribe-14-lang-int8-2026-04-01"
+  val modelConfig = OfflineModelConfig(
+      cohereTranscribe = OfflineCohereTranscribeModelConfig(
+          encoder = "$modelDir/encoder.int8.onnx",
+          decoder = "$modelDir/decoder.int8.onnx",
+          usePunct = true,
+          useItn = true,
+      ),
+      tokens = "$modelDir/tokens.txt",
+      numThreads = 2,
+      debug = false,
+  )
+
+  val config = OfflineRecognizerConfig(
+      modelConfig = modelConfig,
+  )
+
+  return OfflineRecognizer(config = config)
+}
diff --git a/sherpa-onnx/csrc/session.cc b/sherpa-onnx/csrc/session.cc
@@ -172,7 +172,7 @@ Ort::SessionOptions GetSessionOptionsImpl(
   }
 
   if (config.find("ProfilingFilePrefix") != config.end()) {
-    sess_opts.EnableProfiling(config["ProfilingFilePrefix"].c_str());
+    sess_opts.EnableProfiling(SHERPA_ONNX_TO_ORT_PATH(config["ProfilingFilePrefix"]));
     config.erase("ProfilingFilePrefix");
   }
 
diff --git a/sherpa-onnx/java-api/Makefile b/sherpa-onnx/java-api/Makefile
@@ -31,8 +31,9 @@ java_files += OnlineRecognizerConfig.java
 java_files += OnlineRecognizerResult.java
 java_files += OnlineRecognizer.java
 
-java_files += OfflineTransducerModelConfig.java
+java_files += OfflineCohereTranscribeModelConfig.java
 java_files += OfflineParaformerModelConfig.java
+java_files += OfflineTransducerModelConfig.java
 java_files += OfflineWhisperModelConfig.java
 java_files += OfflineFireRedAsrModelConfig.java
 java_files += OfflineMoonshineModelConfig.java
diff --git a/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineCohereTranscribeModelConfig.java b/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineCohereTranscribeModelConfig.java
@@ -0,0 +1,78 @@
+package com.k2fsa.sherpa.onnx;
+
+public class OfflineCohereTranscribeModelConfig {
+    private final String encoder;
+    private final String decoder;
+    private final String language;
+    private final boolean usePunct;
+    private final boolean useItn;
+
+    private OfflineCohereTranscribeModelConfig(Builder builder) {
+        this.encoder = builder.encoder;
+        this.decoder = builder.decoder;
+        this.language = builder.language;
+        this.usePunct = builder.usePunct;
+        this.useItn = builder.useItn;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getEncoder() {
+        return encoder;
+    }
+
+    public String getDecoder() {
+        return decoder;
+    }
+
+    public String getLanguage() {
+        return language;
+    }
+
+    public boolean isUsePunct() {
+        return usePunct;
+    }
+
+    public boolean isUseItn() {
+        return useItn;
+    }
+
+    public static class Builder {
+        private String encoder = "";
+        private String decoder = "";
+        private String language = "";
+        private boolean usePunct = true;
+        private boolean useItn = true;
+
+        public OfflineCohereTranscribeModelConfig build() {
+            return new OfflineCohereTranscribeModelConfig(this);
+        }
+
+        public Builder setEncoder(String encoder) {
+            this.encoder = encoder;
+            return this;
+        }
+
+        public Builder setDecoder(String decoder) {
+            this.decoder = decoder;
+            return this;
+        }
+
+        public Builder setLanguage(String language) {
+            this.language = language;
+            return this;
+        }
+
+        public Builder setUsePunct(boolean usePunct) {
+            this.usePunct = usePunct;
+            return this;
+        }
+
+        public Builder setUseItn(boolean useItn) {
+            this.useItn = useItn;
+            return this;
+        }
+    }
+}
diff --git a/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineModelConfig.java b/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineModelConfig.java
@@ -19,6 +19,7 @@ public class OfflineModelConfig {
     private final OfflineFunAsrNanoModelConfig funasrNano;
     private final OfflineQwen3AsrModelConfig qwen3Asr;
     private final OfflineCanaryModelConfig canary;
+    private final OfflineCohereTranscribeModelConfig cohereTranscribe;
     private final String teleSpeech;
     private final String tokens;
     private final int numThreads;
@@ -46,6 +47,7 @@ private OfflineModelConfig(Builder builder) {
         this.qwen3Asr = builder.qwen3Asr;
         this.senseVoice = builder.senseVoice;
         this.dolphin = builder.dolphin;
+        this.cohereTranscribe = builder.cohereTranscribe;
         this.teleSpeech = builder.teleSpeech;
         this.tokens = builder.tokens;
         this.numThreads = builder.numThreads;
@@ -124,6 +126,10 @@ public OfflineCanaryModelConfig getCanary() {
         return canary;
     }
 
+    public OfflineCohereTranscribeModelConfig getCohereTranscribe() {
+        return cohereTranscribe;
+    }
+
     public String getTokens() {
         return tokens;
     }
@@ -173,6 +179,8 @@ public static class Builder {
         private OfflineFunAsrNanoModelConfig funasrNano = OfflineFunAsrNanoModelConfig.builder().build();
         private OfflineQwen3AsrModelConfig qwen3Asr = OfflineQwen3AsrModelConfig.builder().build();
         private OfflineCanaryModelConfig canary = OfflineCanaryModelConfig.builder().build();
+        private OfflineCohereTranscribeModelConfig cohereTranscribe =
+                OfflineCohereTranscribeModelConfig.builder().build();
         private String teleSpeech = "";
         private String tokens = "";
         private int numThreads = 1;
@@ -246,6 +254,11 @@ public Builder setCanary(OfflineCanaryModelConfig canary) {
             return this;
         }
 
+        public Builder setCohereTranscribe(OfflineCohereTranscribeModelConfig cohereTranscribe) {
+            this.cohereTranscribe = cohereTranscribe;
+            return this;
+        }
+
         public Builder setTeleSpeech(String teleSpeech) {
             this.teleSpeech = teleSpeech;
             return this;
diff --git a/sherpa-onnx/jni/offline-recognizer.cc b/sherpa-onnx/jni/offline-recognizer.cc
diff --git a/sherpa-onnx/jni/sherpa-onnx-symbols.exp b/sherpa-onnx/jni/sherpa-onnx-symbols.exp
diff --git a/sherpa-onnx/kotlin-api/OfflineRecognizer.kt b/sherpa-onnx/kotlin-api/OfflineRecognizer.kt

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ Ort::SessionOptions GetSessionOptionsImpl(`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`if (config.find("ProfilingFilePrefix") != config.end()) {`
`175`		`- sess_opts.EnableProfiling(config["ProfilingFilePrefix"].c_str());`
	`175`	`+ sess_opts.EnableProfiling(SHERPA_ONNX_TO_ORT_PATH(config["ProfilingFilePrefix"]));`
`176`	`176`	`config.erase("ProfilingFilePrefix");`
`177`	`177`	`}`
`178`	`178`