Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 4.84 KB

README.md

File metadata and controls

82 lines (60 loc) · 4.84 KB
Raw




Aimybox Android SDK

Open source voice assistant SDK written in Kotlin

Twitter Follow Travis CI Build Maven Central artifact

Embed your own intelligent voice assistant into your existing application or device.

iOS version is available here

Key Features

  • Provides ready to use UI components for fast building of your voice assistant app
  • Modular and independent from speech-to-text and text-to-speech vendors
  • Provides ready to use speech-to-text and text-to-speech implementations like Android platform speechkit, Kaldi, Pocketsphinx, Yandex Cloud speechkit, Google Cloud speechkit, Houndify or Snowboy wake word trigger
  • Works with any NLU providers like Aimylogic, Dialogflow and Rasa
  • Fully customizable and extendable, you can connect any other speech-to-text, text-to-speech and NLU services
  • Open source under Apache 2.0, written in pure Kotlin
  • Embeddable into any application or device running Android
  • Voice skills logic and complexity is not limited by any restrictions
  • Can interact with any local device services and local networks

How to start using

  1. Create a new Android project with next dependencies in the build.gradle file
    android {
        compileOptions {
            sourceCompatibility = JavaVersion.VERSION_1_8
            targetCompatibility = JavaVersion.VERSION_1_8
        }
    }
    
    repositories {
        mavenCentral()
    }
    
    dependencies {
        implementation("com.just-ai.aimybox:core:$aimyboxVersion")
    }

Use the latest version Maven Central

  1. Add one or more dependencies of third party speech-to-text and text-to-speech libraries. For example
implementation("com.just-ai.aimybox:google-platform-speechkit:$aimyboxVersion")

  1. Create a new project in Aimybox console, enable some voice skills and copy your project's API key.

  2. Instantiate Aimybox in your Application class like that

val unitId = UUID.randomUUID().toString()
val textToSpeech = GooglePlatformTextToSpeech(context)
val speechToText = GooglePlatformSpeechToText(context)
val dialogApi = AimyboxDialogApi("your Aimybox project API key", unitId)
val aimybox = Aimybox(Config.create(speechToText, textToSpeech, dialogApi))

Now you can start talking with your voice assistant using startRecognition() method of Aimybox.

More details

Please refer to the demo voice assistant to see how to use Aimybox library in your project. There are much more features described in our Android SDK documentation.

Documentation

There is a full Aimybox documentation available here