Koaks-ai

The name "Koaks" is homophonic with "coax".

🌐   English | 中文

🧩 Connect your tools, compose your logic, rule your agents.

🚀 Quick Start

1. Preparation

• Kotlin 2.x / JDK 21 or higher
• Maven or Gradle build tool
• An available LLM API Key (e.g., OpenAI, DeepSeek)

2. Add Dependencies

• Gradle (Kotlin DSL)

// For Gradle projects, whether it's a JVM project or a Kotlin Multiplatform project, 
// you only need to add the following. Gradle will automatically handle platform adaptation.
implementation("io.github.mynna404:koaks-core:0.0.1-preview3")
implementation("io.github.mynna404:koaks-qwen:0.0.1-preview3")

• Maven

<!-- For Maven projects, you need to distinguish between different platforms yourself. 
     Of course, if you’re not sure what that means, you can simply add the following to your pom.xml. -->
<dependency>
  <groupId>io.github.mynna404</groupId>
  <artifactId>koaks-core-jvm</artifactId>
  <version>0.0.1-preview2</version>
</dependency>

<dependency>
  <groupId>io.github.mynna404</groupId>
  <artifactId>koaks-qwen-jvm</artifactId>
  <version>0.0.1-preview3</version>
</dependency>

3. Simple

Warning: The current project is in a rapid iteration phase, and the API may change at any time.

Connect to ChatGPT and Send a Message

suspend fun main() {
    val client = createChatClient {
        model {
            qwen(
                baseUrl = "base-url",
                apiKey = "api-key",
                modelName = "qwen3-235b-a22b-instruct-2507",
            )
        }
    }

    val result = client.generate("What's the meaning of life?")
    println(result)
}

Chat with Memory

suspend fun main() {
    val client = createChatClient {
        model {
            qwen(
                baseUrl = "base-url",
                apiKey = "api-key",
                modelName = "qwen3-235b-a22b-instruct-2507",
            )
        }
        memory {
            default()
        }
    }

    val result = client.chatWithMemory("What's the meaning of life?", "1001")
    println(resp0.value.choices?.getOrNull(0)?.message?.content)
}

Streaming Response

suspend fun main() {
    val client = createChatClient {
        model {
            qwen(
                baseUrl = "base-url",
                apiKey = "api-key",
                modelName = "qwen3-235b-a22b-instruct-2507",
            )
        }
    }

    val chatRequest = ChatRequest(
        message = "What's the meaning of life?"
    ).apply {
        params.stream = true
    }

    val result = client.chat(chatRequest)

    result.stream.map { data ->
        print(data.choices?.get(0)?.delta?.content)
    }.collect()

}

Tool Call

class WeatherTools {

    @Tool(
        params = [
            Param(param = "city", description = "city name, like Shanghai", required = true),
            Param(param = "date", description = "date, like 2025-08-17", required = true)
        ],
        group = "weather",
        description = "Get the weather for a specific city today."
    )
    fun getWeather(city: String, date: String): String {
        return "For $city on $date, the weather is cloudy with a high wind warning."
    }

    @Tool(
        group = "location",
        description = "Get the city where the user is located"
    )
    fun getCity(): String {
        return "Shanghai"
    }

}


fun main() {
    Koaks.init(arrayOf("your package"))
    runBlocking {
        val client = createChatClient {
            model {
                qwen(
                    baseUrl = "base-url",
                    apiKey = "api-key",
                    modelName = "qwen3-235b-a22b-instruct-2507",
                )
            }
            memory {
                default()
            }
            tools {
                default()
                groups("weather", "location")
            }
        }

        val chatRequest = ChatRequest(
            message = "What's the weather like?"
        ).apply {
            // when using tool_call, stream mode is currently not supported
            params.stream = false
            params.parallelToolCalls = true
        }

        val result = client.chat(chatRequest)

        println(result.value.choices?.getOrNull(0)?.message?.content)
    }

}

🤝 Contributing Guide

Thank you for your interest in contributing! You are welcome to contribute code, improve documentation, or submit issues.

1.	Fork the repository
2.	Create a new branch (git checkout -b feature-xxx)
3.	Commit your changes (git commit -m 'Add new feature')
4.	Push your branch (git push origin feature-xxx)
5.	Create a Pull Request

💖 Acknowledgements

This project makes use of, but is not limited to, the following open-source projects:

Project	Description
Kotlin	The Kotlin Programming Language.
kotlin-logging	Lightweight multiplatform logging framework for Kotlin. A convenient and performant logging facade.