README.md

Align AI Kotlin SDK

This is the official server-side JVM SDK for Align AI. This library allows you to easily send your data to Align AI.

Visit the full documentation to see the detailed usage.

Installation

Install the Kotlin SDK through Build chain (Gradle, Maven):

repositories {
    mavenCentral()

    // Jitpack for Align AI SDK itself
    maven {
        url = uri("https://jitpack.io")
    }

    // Buf for Align AI API Schema (Dependencies)
    maven {
        name = "buf"
        url = uri("https://buf.build/gen/maven")
    }
}

dependencies {
    ...

    // SDK
    implementation("com.github.coxwave:alignai-sdk-kotlin:0.4.0")

    // SDK Dependencies
    implementation("com.squareup.okhttp3:okhttp:4.12.0")
    implementation("com.connectrpc:connect-kotlin-okhttp:0.7.1")
    implementation("com.connectrpc:connect-kotlin-google-java-ext:0.7.1")
    implementation("com.google.protobuf:protobuf-kotlin:4.28.3")
    implementation("build.buf.gen:impaction-ai_ingestion_connectrpc_kotlin:0.7.1.1.20240908234409.342910308823")
    implementation("build.buf.gen:impaction-ai_ingestion_protocolbuffers_kotlin:28.3.0.2.20240908234409.342910308823")

    // Coroutine
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
}

Contribution

If you have any issues with the SDK, feel free to open Github issues and we'll get to it as soon as possible.

We welcome your contributions and suggestions!