Package, type and module clean up. (#335)

* rename package `auto` to `conversation`

* Remove unused `Program`

* Rename package `vectorstores` to `store`

* Remove unused AI error types

* Change scala `auto` package to `conversation`, remove unused types and modules

* Remove cats module until we have a solution based on the methods exported as CompletableFuture

core/src/commonMain/kotlin/com/xebia/functional/xef/AIError.kt

@@ -1,32 +1,13 @@
 package com.xebia.functional.xef
 
 import arrow.core.NonEmptyList
-import com.xebia.functional.xef.llm.models.chat.Message
 import kotlin.jvm.JvmOverloads
 
 sealed class AIError @JvmOverloads constructor(message: String, cause: Throwable? = null) :
   RuntimeException(message, cause) {
 
   class NoResponse : AIError("No response from the AI")
 
-  data class MessagesExceedMaxTokenLength(
-    val messages: List<Message>,
-    val promptTokens: Int,
-    val maxTokens: Int
-  ) :
-    AIError(
-      "Prompt exceeds max token length: $promptTokens + $maxTokens = ${promptTokens + maxTokens}"
-    )
-
-  data class PromptExceedsMaxTokenLength(
-    val prompt: String,
-    val promptTokens: Int,
-    val maxTokens: Int
-  ) :
-    AIError(
-      "Prompt exceeds max token length: $promptTokens + $maxTokens = ${promptTokens + maxTokens}"
-    )
-
   data class PromptExceedsMaxRemainingTokenLength(val promptTokens: Int, val maxTokens: Int) :
     AIError(
       "Prompt exceeds max remaining token length: $promptTokens + $maxTokens = ${promptTokens + maxTokens}"

core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/AiDsl.kt

@@ -0,0 +1,3 @@
+package com.xebia.functional.xef.conversation
+
+@DslMarker annotation class AiDsl

core/src/commonMain/kotlin/com/xebia/functional/xef/auto/AutoClose.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/AutoClose.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import arrow.atomic.Atomic
 import arrow.atomic.update

core/src/commonMain/kotlin/com/xebia/functional/xef/auto/Conversation.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/Conversation.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import com.xebia.functional.xef.AIError
 import com.xebia.functional.xef.llm.Chat
@@ -7,8 +7,8 @@ import com.xebia.functional.xef.llm.Images
 import com.xebia.functional.xef.llm.models.functions.CFunction
 import com.xebia.functional.xef.llm.models.images.ImagesGenerationResponse
 import com.xebia.functional.xef.prompt.Prompt
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 import kotlin.jvm.JvmSynthetic
 import kotlinx.coroutines.flow.Flow
 import kotlinx.serialization.KSerializer

core/src/commonMain/kotlin/com/xebia/functional/xef/auto/Description.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/Description.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.SerialInfo

core/src/commonMain/kotlin/com/xebia/functional/xef/auto/MessagePolicy.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/MessagePolicy.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import kotlinx.serialization.Serializable
 

core/src/commonMain/kotlin/com/xebia/functional/xef/auto/PlatformConversation.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/conversation/PlatformConversation.kt

@@ -1,7 +1,7 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 
 expect abstract class PlatformConversation(
   store: VectorStore,

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/Chat.kt

@@ -2,8 +2,8 @@ package com.xebia.functional.xef.llm
 
 import com.xebia.functional.tokenizer.ModelType
 import com.xebia.functional.xef.AIError
-import com.xebia.functional.xef.auto.AiDsl
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.AiDsl
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.models.chat.*
 import com.xebia.functional.xef.prompt.Prompt
 import kotlinx.coroutines.flow.Flow

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/ChatWithFunctions.kt

@@ -3,8 +3,8 @@ package com.xebia.functional.xef.llm
 import arrow.core.nonFatalOrThrow
 import arrow.core.raise.catch
 import com.xebia.functional.xef.AIError
-import com.xebia.functional.xef.auto.AiDsl
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.AiDsl
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.models.chat.ChatCompletionRequestWithFunctions
 import com.xebia.functional.xef.llm.models.chat.ChatCompletionResponseWithFunctions
 import com.xebia.functional.xef.llm.models.functions.CFunction

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/Images.kt

@@ -3,7 +3,7 @@ package com.xebia.functional.xef.llm
 import com.xebia.functional.xef.llm.models.images.ImagesGenerationRequest
 import com.xebia.functional.xef.llm.models.images.ImagesGenerationResponse
 import com.xebia.functional.xef.prompt.Prompt
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.VectorStore
 
 interface Images : LLM {
   suspend fun createImages(request: ImagesGenerationRequest): ImagesGenerationResponse

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/MemoryManagement.kt

@@ -1,8 +1,8 @@
 package com.xebia.functional.xef.llm
 
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.models.chat.*
-import com.xebia.functional.xef.vectorstores.Memory
+import com.xebia.functional.xef.store.Memory
 import io.ktor.util.date.*
 
 internal object MemoryManagement {

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/PromptCalculator.kt

@@ -2,11 +2,11 @@ package com.xebia.functional.xef.llm
 
 import com.xebia.functional.tokenizer.truncateText
 import com.xebia.functional.xef.AIError
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.models.chat.Message
 import com.xebia.functional.xef.prompt.Prompt
 import com.xebia.functional.xef.prompt.templates.assistant
-import com.xebia.functional.xef.vectorstores.Memory
+import com.xebia.functional.xef.store.Memory
 
 internal object PromptCalculator {
 

core/src/commonMain/kotlin/com/xebia/functional/xef/llm/models/functions/JsonSchema.kt

@@ -13,7 +13,7 @@ which states the following:
 
 // TODO: We should consider a fork and maintain it ourselves.
  */
-import com.xebia.functional.xef.auto.Description
+import com.xebia.functional.xef.conversation.Description
 import kotlin.jvm.JvmMultifileClass
 import kotlin.jvm.JvmName
 import kotlinx.serialization.ExperimentalSerializationApi

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/configuration/PromptConfiguration.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.configuration
 
-import com.xebia.functional.xef.auto.MessagePolicy
+import com.xebia.functional.xef.conversation.MessagePolicy
 import com.xebia.functional.xef.llm.models.chat.Role
 import kotlin.jvm.JvmField
 import kotlin.jvm.JvmOverloads

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/evaluator/PromptEvaluator.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.evaluator
 
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.Chat
 import com.xebia.functional.xef.prompt.Prompt
 import com.xebia.functional.xef.prompt.templates.system

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/expressions/Expression.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.expressions
 
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.ChatWithFunctions
 import com.xebia.functional.xef.llm.models.chat.Message
 import com.xebia.functional.xef.prompt.Prompt

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/expressions/ReplacedValues.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.expressions
 
-import com.xebia.functional.xef.auto.Description
+import com.xebia.functional.xef.conversation.Description
 import kotlinx.serialization.Serializable
 
 @Serializable

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/expressions/Replacement.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.expressions
 
-import com.xebia.functional.xef.auto.Description
+import com.xebia.functional.xef.conversation.Description
 import kotlinx.serialization.Serializable
 
 @Serializable

core/src/commonMain/kotlin/com/xebia/functional/xef/prompt/lang/Infer.kt

@@ -1,6 +1,6 @@
 package com.xebia.functional.xef.prompt.lang
 
-import com.xebia.functional.xef.auto.Conversation
+import com.xebia.functional.xef.conversation.Conversation
 import com.xebia.functional.xef.llm.ChatWithFunctions
 import com.xebia.functional.xef.prompt.Prompt
 import com.xebia.functional.xef.prompt.templates.system

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/CombinedVectorStore.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/CombinedVectorStore.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.embeddings.Embedding
 

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/ConversationId.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/ConversationId.kt

@@ -1,3 +1,3 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 data class ConversationId(val value: String)

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/LocalVectorStore.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/LocalVectorStore.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import arrow.atomic.Atomic
 import arrow.atomic.getAndUpdate

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/Memory.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/Memory.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.llm.models.chat.Message
 

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/MemoryUtils.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/MemoryUtils.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 fun List<Memory>.reduceByLimitToken(limitTokens: Int): List<Memory> =
   fold(Pair(0, emptyList<Memory>())) { (accTokens, list), memory ->

core/src/commonMain/kotlin/com/xebia/functional/xef/vectorstores/VectorStore.kt → core/src/commonMain/kotlin/com/xebia/functional/xef/store/VectorStore.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.embeddings.Embedding
 import kotlin.jvm.JvmStatic

core/src/commonTest/kotlin/com/xebia/functional/xef/auto/ConversationSpec.kt → core/src/commonTest/kotlin/com/xebia/functional/xef/conversation/ConversationSpec.kt

@@ -1,13 +1,13 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import com.xebia.functional.tokenizer.ModelType
 import com.xebia.functional.xef.data.TestEmbeddings
 import com.xebia.functional.xef.data.TestModel
 import com.xebia.functional.xef.llm.models.chat.Message
 import com.xebia.functional.xef.llm.models.chat.Role
 import com.xebia.functional.xef.prompt.Prompt
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.LocalVectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.LocalVectorStore
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.ints.shouldBeLessThan
 import io.kotest.matchers.shouldBe

core/src/commonTest/kotlin/com/xebia/functional/xef/auto/MessagesData.kt → core/src/commonTest/kotlin/com/xebia/functional/xef/conversation/MessagesData.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 val lorem =
   "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

core/src/commonTest/kotlin/com/xebia/functional/xef/vectorstores/CombinedVectorStoreSpec.kt → core/src/commonTest/kotlin/com/xebia/functional/xef/store/CombinedVectorStoreSpec.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.data.TestEmbeddings
 import io.kotest.core.spec.style.StringSpec

core/src/commonTest/kotlin/com/xebia/functional/xef/vectorstores/LocalVectorStoreSpec.kt → core/src/commonTest/kotlin/com/xebia/functional/xef/store/LocalVectorStoreSpec.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.data.TestEmbeddings
 import io.kotest.core.spec.style.StringSpec

core/src/commonTest/kotlin/com/xebia/functional/xef/vectorstores/MemoryData.kt → core/src/commonTest/kotlin/com/xebia/functional/xef/store/MemoryData.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.vectorstores
+package com.xebia.functional.xef.store
 
 import com.xebia.functional.xef.llm.models.chat.Message
 import com.xebia.functional.xef.llm.models.chat.Role

core/src/jsMain/kotlin/com/xebia/functional/xef/auto/Description.js.kt → core/src/jsMain/kotlin/com/xebia/functional/xef/conversation/Description.js.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 import kotlinx.serialization.SerialInfo
 

core/src/jsMain/kotlin/com/xebia/functional/xef/auto/JSConversation.kt → core/src/jsMain/kotlin/com/xebia/functional/xef/conversation/JSConversation.kt

@@ -1,7 +1,7 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 
 class JSConversation(
   override val store: VectorStore,

core/src/jsMain/kotlin/com/xebia/functional/xef/auto/PlatformConversation.js.kt → core/src/jsMain/kotlin/com/xebia/functional/xef/conversation/PlatformConversation.js.kt

@@ -1,7 +1,7 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 
 actual abstract class PlatformConversation
 actual constructor(store: VectorStore, conversationId: ConversationId?) : Conversation, AutoClose {

core/src/jvmMain/java/com/xebia/functional/xef/auto/jvm/Description.java → core/src/jvmMain/java/com/xebia/functional/xef/conversation/jvm/Description.java

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto.jvm;
+package com.xebia.functional.xef.conversation.jvm;
 
 import java.lang.annotation.*;
 

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/Description.jvm.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/Description.jvm.kt

@@ -1,6 +1,6 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.auto.jvm.Description
+import com.xebia.functional.xef.conversation.jvm.Description
 
 /**
  * Description of a property to enhance the LLM prompt chances to get the data in the right format

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/FromJson.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/FromJson.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
 fun interface FromJson<A> {
   fun fromJson(a: String): A

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/JVMConversation.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/JVMConversation.kt

@@ -1,7 +1,7 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 import java.io.Closeable
 
 open class JVMConversation(

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/PlatformConversation.jvm.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/PlatformConversation.jvm.kt

@@ -1,14 +1,14 @@
-package com.xebia.functional.xef.auto
+package com.xebia.functional.xef.conversation
 
-import com.xebia.functional.xef.auto.serialization.JacksonSerialization
+import com.xebia.functional.xef.conversation.serialization.JacksonSerialization
 import com.xebia.functional.xef.llm.Chat
 import com.xebia.functional.xef.llm.ChatWithFunctions
 import com.xebia.functional.xef.llm.Images
 import com.xebia.functional.xef.llm.models.functions.CFunction
 import com.xebia.functional.xef.llm.models.images.ImagesGenerationResponse
 import com.xebia.functional.xef.prompt.Prompt
-import com.xebia.functional.xef.vectorstores.ConversationId
-import com.xebia.functional.xef.vectorstores.VectorStore
+import com.xebia.functional.xef.store.ConversationId
+import com.xebia.functional.xef.store.VectorStore
 import java.util.concurrent.CompletableFuture
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.SupervisorJob

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/futures/ExecutionContext.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/futures/ExecutionContext.kt

@@ -1,4 +1,4 @@
-package com.xebia.functional.xef.auto.futures
+package com.xebia.functional.xef.conversation.futures
 
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.ExecutorService

core/src/jvmMain/kotlin/com/xebia/functional/xef/auto/serialization/DescriptionModule.kt → core/src/jvmMain/kotlin/com/xebia/functional/xef/conversation/serialization/DescriptionModule.kt

@@ -1,10 +1,10 @@
-package com.xebia.functional.xef.auto.serialization
+package com.xebia.functional.xef.conversation.serialization
 
 import com.github.victools.jsonschema.generator.MemberScope
 import com.github.victools.jsonschema.generator.Module
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
 import com.github.victools.jsonschema.generator.TypeScope
-import com.xebia.functional.xef.auto.Description
+import com.xebia.functional.xef.conversation.Description
 
 internal class DescriptionModule : Module {
   override fun applyToConfigBuilder(builder: SchemaGeneratorConfigBuilder) {