Very very first version of kotlin-sdk for lmos

hsudbrock · Robert Winkler · commit f5a4107834f2 · 2025-02-28T09:28:16.000+01:00
diff --git a/lmos-kotlin-sdk-base/build.gradle.kts b/lmos-kotlin-sdk-base/build.gradle.kts
@@ -0,0 +1,4 @@
+dependencies {
+    api(project(":kotlin-wot"))
+    implementation("org.jetbrains.kotlin:kotlin-reflect")
+}
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/DataSchemaBuilder.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/DataSchemaBuilder.kt
@@ -0,0 +1,85 @@
+package ai.ancf.lmos.kotlinsdk.base
+
+import ai.ancf.lmos.wot.thing.schema.*
+import kotlin.reflect.KClass
+import kotlin.reflect.KType
+import kotlin.reflect.full.memberProperties
+
+object DataSchemaBuilder {
+
+    // TODO: Move to kotlin-wot
+
+    fun mapTypeToSchema(type: KType): DataSchema<out Any> {
+        return when (type.classifier) {
+            Int::class -> IntegerSchema()
+            Float::class -> NumberSchema()
+            Double::class -> NumberSchema()
+            Long::class -> NumberSchema()
+            String::class -> StringSchema()
+            Boolean::class -> BooleanSchema()
+            List::class, Set::class -> {
+                val genericType = type.arguments.firstOrNull()?.type
+                val itemSchema = if (genericType != null) {
+                    mapTypeToSchema(genericType)
+                } else {
+                    StringSchema()
+                }
+                ArraySchema(items = itemSchema)
+            }
+            IntArray::class -> ArraySchema(items = IntegerSchema())
+            FloatArray::class -> ArraySchema(items = NumberSchema())
+            DoubleArray::class -> ArraySchema(items = NumberSchema())
+            NumberSchema::class -> ArraySchema(items = NumberSchema())
+            Array<String>::class -> ArraySchema(items = StringSchema())
+            Array<Number>::class -> ArraySchema(items = NumberSchema())
+            Array<Boolean>::class -> ArraySchema(items = BooleanSchema())
+            Array<Int>::class -> ArraySchema(items = IntegerSchema())
+            Array<Float>::class -> ArraySchema(items = NumberSchema())
+            Array<Long>::class -> ArraySchema(items = NumberSchema())
+            Unit::class -> NullSchema()
+            else -> buildObjectSchema(type)
+        }
+    }
+
+    private fun buildObjectSchema(type: KType): ObjectSchema {
+        if (type.classifier == Map::class) {
+            return buildMapSchema(type)
+        }
+
+        val kClass = type.classifier as? KClass<*>
+            ?: throw IllegalArgumentException("Type is not a valid class: $type")
+
+        val (properties, required) = extractProperties(kClass)
+        return ObjectSchema(properties, required)
+    }
+
+    private fun buildMapSchema(type: KType): ObjectSchema {
+        val keyType = type.arguments.getOrNull(0)?.type
+        val valueType = type.arguments.getOrNull(1)?.type
+
+        val keySchema = if (keyType != null) mapTypeToSchema(keyType) else StringSchema()
+        val valueSchema = if (valueType != null) mapTypeToSchema(valueType) else StringSchema()
+
+        return ObjectSchema(
+            properties = mutableMapOf(
+                "keys" to ArraySchema(items = keySchema),
+                "values" to ArraySchema(items = valueSchema)
+            )
+        )
+    }
+
+    private fun extractProperties(kClass: KClass<*>): Pair<MutableMap<String, DataSchema<*>>, MutableList<String>> {
+        val properties: MutableMap<String, DataSchema<*>> = mutableMapOf()
+        val required: MutableList<String> = mutableListOf()
+
+        kClass.memberProperties.forEach { property ->
+            val returnType = property.returnType
+            val schemaForParam = mapTypeToSchema(returnType)
+            properties[property.name] = schemaForParam
+            if (!returnType.isMarkedNullable) {
+                required.add(property.name)
+            }
+        }
+        return Pair(properties, required)
+    }
+}
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/LmosContext.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/LmosContext.kt
@@ -0,0 +1,6 @@
+package ai.ancf.lmos.kotlinsdk.base
+
+object LMOSContext {
+        const val prefix = "lmos"
+        const val url = "https://eclipse.dev/lmos/protocol/v1"
+}
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/LmosThingTypes.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/LmosThingTypes.kt
@@ -0,0 +1,8 @@
+package ai.ancf.lmos.kotlinsdk.base
+
+import ai.ancf.lmos.wot.thing.schema.Type
+
+object LmosThingTypes {
+    val TOOL = Type("lmos:Tool")
+    val AGENT = Type("lmos:Agent")
+}
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AgentRequest.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AgentRequest.kt
@@ -0,0 +1,30 @@
+package ai.ancf.lmos.kotlinsdk.base.model
+
+data class AgentRequest(
+    val messages: List<Message>,
+    val conversationContext: ConversationContext,
+    val systemContext: List<SystemContextEntry>,
+    val userContext: UserContext,
+)
+
+data class UserContext(
+    val userId: String? = null,
+    val userToken: String? = null,
+    val profile: List<ProfileEntry>,
+)
+
+data class ConversationContext(
+    val conversationId: String,
+    val turnId: String? = null,
+    val anonymizationEntities: List<AnonymizationEntity>? = null,
+)
+
+data class ProfileEntry(
+    val key: String,
+    val value: String,
+)
+
+data class SystemContextEntry(
+    val key: String,
+    val value: String,
+)
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AgentResult.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AgentResult.kt
@@ -0,0 +1,8 @@
+package ai.ancf.lmos.kotlinsdk.base.model
+
+data class AgentResult(
+    val status: String? = null,
+    val responseTime: Double = -1.0,
+    val messages: List<Message>,
+    val anonymizationEntities: List<AnonymizationEntity>? = null,
+)
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AnonymizationEntity.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/AnonymizationEntity.kt
@@ -0,0 +1,3 @@
+package ai.ancf.lmos.kotlinsdk.base.model
+
+data class AnonymizationEntity(val type: String, val value: String, val replacement: String)
diff --git a/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/Message.kt b/lmos-kotlin-sdk-base/src/main/kotlin/ai/ancf/lmos/kotlinsdk/base/model/Message.kt
@@ -0,0 +1,11 @@
+package ai.ancf.lmos.kotlinsdk.base.model
+
+data class Message(
+    val role: String,
+    val content: String,
+    val format: String = "text",
+    val turnId: String? = null,
+    val binaryData: List<BinaryData>? = null,
+)
+
+class BinaryData(val mimeType: String, val dataAsBase64: String? = null, val source: String? = null)
diff --git a/lmos-kotlin-sdk-client/build.gradle.kts b/lmos-kotlin-sdk-client/build.gradle.kts
@@ -0,0 +1,5 @@
+dependencies {
+    api(project(":kotlin-wot"))
+    api(project(":lmos-kotlin-sdk-base"))
+    implementation("org.slf4j:slf4j-api:2.0.16")
+}
diff --git a/lmos-kotlin-sdk-server/build.gradle.kts b/lmos-kotlin-sdk-server/build.gradle.kts
@@ -0,0 +1,29 @@
+dependencies {
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.9.0")
+    api(project(":kotlin-wot"))
+    api(project(":lmos-kotlin-sdk-base"))
+    implementation("org.slf4j:slf4j-api:2.0.16")
+
+    testImplementation(platform("io.ktor:ktor-bom:3.1.0"))
+    testImplementation(project(":kotlin-wot-binding-http"))
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.0")
+    testImplementation("io.ktor:ktor-client-okhttp")
+    testImplementation("io.ktor:ktor-client-json")
+    testImplementation("io.ktor:ktor-client-jackson")
+    testImplementation("io.ktor:ktor-client-serialization")
+    testImplementation("io.ktor:ktor-client-content-negotiation")
+    testImplementation("io.ktor:ktor-serialization-jackson")
+    testImplementation("org.assertj:assertj-core:3.24.2")
+}
+
+tasks.register("listConfigurations") {
+    doLast {
+        configurations.forEach { config ->
+            println("Configuration: ${config.name}")
+            println("  Can be resolved: ${config.isCanBeResolved}")
+            println("  Can be consumed: ${config.isCanBeConsumed}")
+            println("  Extends from: ${config.extendsFrom.joinToString { it.name }}")
+            println()
+        }
+    }
+}
diff --git a/lmos-kotlin-sdk-server/src/main/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosAgent.kt b/lmos-kotlin-sdk-server/src/main/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosAgent.kt
@@ -0,0 +1,15 @@
+package ai.ancf.lmos.kotlinsdk.server
+
+import ai.ancf.lmos.kotlinsdk.base.model.AgentRequest
+import ai.ancf.lmos.kotlinsdk.base.model.AgentResult
+import ai.ancf.lmos.wot.thing.schema.WoTExposedThing
+import kotlinx.coroutines.flow.Flow
+
+data class LmosAgent(
+    var id: String,
+    var title: String,
+    var description: String,
+    var capabilities: String,
+    var chat: (input: AgentRequest) -> AgentResult,
+    // var events: Flow<String>
+)
diff --git a/lmos-kotlin-sdk-server/src/main/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosRuntime.kt b/lmos-kotlin-sdk-server/src/main/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosRuntime.kt
@@ -0,0 +1,69 @@
+package ai.ancf.lmos.kotlinsdk.server
+
+import ai.ancf.lmos.kotlinsdk.base.*
+import ai.ancf.lmos.kotlinsdk.base.model.AgentRequest
+import ai.ancf.lmos.kotlinsdk.base.model.AgentResult
+import ai.ancf.lmos.wot.Servient
+import ai.ancf.lmos.wot.Wot
+import ai.ancf.lmos.wot.thing.DEFAULT_CONTEXT
+import ai.ancf.lmos.wot.thing.schema.*
+import org.slf4j.LoggerFactory
+import kotlin.reflect.full.createType
+
+class LmosRuntime(private val servient: Servient) {
+
+    private val wot = Wot.create(servient)
+
+    suspend fun start() {
+        servient.start()
+        log.info("LmosRuntime started")
+    }
+
+    suspend fun stop() {
+        servient.shutdown()
+        log.info("LmosRuntime stopped")
+    }
+
+    suspend fun add(agent: LmosAgent)  {
+        val agentThing = agent.toThing(wot)
+        servient.addThing(agentThing)
+        servient.expose(agentThing.getThingDescription().id)
+    }
+
+    // TODO: Remove an agent? Currently not possible in kotlin-wot
+
+    companion object {
+        private val log = LoggerFactory.getLogger(LmosRuntime::class.java)
+    }
+
+}
+
+private fun LmosAgent.toThing(wot: Wot): WoTExposedThing {
+    return wot.produce {
+        id = this@toThing.id
+        title = this@toThing.title
+        description = this@toThing.description
+        objectType = LmosThingTypes.AGENT
+
+        val context = Context(DEFAULT_CONTEXT)
+        context.addContext(LMOSContext.prefix, LMOSContext.url)
+        objectContext = context
+
+        version = VersionInfo("1.0.0", null) // TODO: Is this something specified by the agent developer? Or LMOS specific?
+
+        // TODO: Links to capabilities
+
+        // TODO: Really <Any, Any> ?
+        action<Any, Any>("chat") {
+            title = "Chat"
+            description = "Chat with the agent"
+            safe = false
+            idempotent = false
+            // TODO: Is this unsafe cast needed? How to avoid it?
+            input = DataSchemaBuilder.mapTypeToSchema(AgentRequest::class.createType()) as DataSchema<Any>
+            output = DataSchemaBuilder.mapTypeToSchema(AgentResult::class.createType()) as DataSchema<Any>
+        }
+
+        // TODO: add agent events
+    }
+}
diff --git a/lmos-kotlin-sdk-server/src/test/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosRuntimeTest.kt b/lmos-kotlin-sdk-server/src/test/kotlin/ai/ancf/lmos/kotlinsdk/server/LmosRuntimeTest.kt
@@ -0,0 +1,77 @@
+package ai.ancf.lmos.kotlinsdk.server
+
+import ai.ancf.lmos.kotlinsdk.base.model.AgentRequest
+import ai.ancf.lmos.kotlinsdk.base.model.AgentResult
+import ai.ancf.lmos.kotlinsdk.base.model.AnonymizationEntity
+import ai.ancf.lmos.kotlinsdk.base.model.Message
+import ai.ancf.lmos.wot.Servient
+import ai.ancf.lmos.wot.binding.http.HttpProtocolServer
+import com.fasterxml.jackson.databind.DeserializationFeature
+import com.fasterxml.jackson.databind.JsonNode
+import com.fasterxml.jackson.databind.SerializationFeature
+import io.ktor.client.*
+import io.ktor.client.call.*
+import io.ktor.client.engine.okhttp.*
+import io.ktor.client.plugins.contentnegotiation.*
+import io.ktor.client.request.*
+import io.ktor.serialization.jackson.*
+import kotlinx.coroutines.runBlocking
+import org.junit.jupiter.api.Test
+import org.assertj.core.api.Assertions.assertThat
+
+
+class LmosRuntimeTest {
+
+    private val client = HttpClient(OkHttp) {
+        install(ContentNegotiation) {
+            jackson {
+                enable(SerializationFeature.INDENT_OUTPUT)
+                configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+            }
+        }
+    }
+
+    @Test
+    fun test() = runBlocking {
+        val lmosAgent = LmosAgent(
+            id = "my-agent-id",
+            title = "my-agent-title",
+            description = "my agent description",
+            capabilities = "capabilities",
+            chat = { agentRequest -> someAgentResult(agentRequest) },
+        )
+
+        val servient = Servient(servers = listOf(HttpProtocolServer()))
+        val lmosRuntime = LmosRuntime(servient)
+        lmosRuntime.start()
+        lmosRuntime.add(lmosAgent)
+
+        val response: JsonNode = client.get("http://localhost:8080/${lmosAgent.id}").body()
+        assertThat(response.isObject).isTrue()
+        assertThat(response.get("id").asText()).isEqualTo(lmosAgent.id)
+
+        lmosRuntime.stop()
+    }
+
+    private fun someAgentResult(agentRequest: AgentRequest) = AgentResult(
+        status = "some status",
+        responseTime = 1.0,
+        messages = listOf(
+            Message(
+                role = "some role",
+                content = "some content",
+                format = "some format",
+                turnId = "some turn id",
+                binaryData = null
+            )
+        ),
+        anonymizationEntities = listOf(
+            AnonymizationEntity(
+                type = "some type",
+                value = "some value",
+                replacement = "some replacement",
+            )
+        )
+    )
+
+}
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -18,4 +18,7 @@ include("kotlin-wot-integration-tests")
 include("kotlin-wot-reflection")
 include("kotlin-wot-spring-boot-starter")
 include("kotlin-wot-tool-example")
-include("kotlin-wot-lmos-protocol")
+include("kotlin-wot-lmos-protocol")
+include("lmos-kotlin-sdk-base")
+include("lmos-kotlin-sdk-client")
+include("lmos-kotlin-sdk-server")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package ai.ancf.lmos.kotlinsdk.base.model`
	`2`	`+`
	`3`	`+data class AnonymizationEntity(val type: String, val value: String, val replacement: String)`