feat: Add ImageGenerations API

renatoarg · renatoarg · commit 52fcf6896abb · 2023-03-08T18:48:39.000-03:00
diff --git a/sample/android/src/main/java/co/yml/ychat/android/MainViewModel.kt b/sample/android/src/main/java/co/yml/ychat/android/MainViewModel.kt
@@ -1,11 +1,13 @@
 package co.yml.ychat.android
 
+import android.util.Log
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import co.yml.ychat.YChat
+import co.yml.ychat.YChat.Callback
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 
@@ -20,6 +22,11 @@ class MainViewModel(private val chatGpt: YChat) : ViewModel() {
             )
     }
 
+    private val imageGenerations by lazy {
+        chatGpt.imageGenerations()
+            .setResults(2)
+    }
+
     private val _items = mutableStateListOf<MessageItem>()
     val items = _items
 
@@ -41,6 +48,20 @@ class MainViewModel(private val chatGpt: YChat) : ViewModel() {
         }
     }
 
+    fun onImageRequest(prompt: String) {
+        viewModelScope.launch {
+            imageGenerations.execute(prompt, object: Callback<List<String>> {
+                override fun onSuccess(result: List<String>) {
+                    Log.d("callback", "onSuccess: $result")
+                }
+
+                override fun onError(throwable: Throwable) {
+                    Log.d("callback", "onError: $throwable")
+                }
+            })
+        }
+    }
+
     private suspend fun showTypingAnimation(message: String) {
         items.add(MessageItem(message = message, isOut = true))
         delay((1000..2000).random().toLong())
diff --git a/sample/android/src/main/java/co/yml/ychat/android/ui/SendMessageLayout.kt b/sample/android/src/main/java/co/yml/ychat/android/ui/SendMessageLayout.kt
@@ -91,7 +91,8 @@ fun SendMessageLayout() {
                     .background(if (textFieldState.isNotEmpty() && isLoading.not()) colorResource(id = R.color.softBlue) else colorResource(id = R.color.opaqueWhite)),
                 onClick = {
                     scope.launch {
-                        viewModel.onSendMessage(textFieldState, typingString)
+                        //viewModel.onSendMessage(textFieldState, typingString)
+                        viewModel.onImageRequest(textFieldState)
                         textFieldState = ""
                     }
                 },
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/YChat.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/YChat.kt
@@ -2,6 +2,7 @@ package co.yml.ychat
 
 import co.yml.ychat.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
+import co.yml.ychat.entrypoint.features.ImageGenerations
 import co.yml.ychat.entrypoint.impl.YChatImpl
 import kotlin.jvm.JvmStatic
 import kotlin.jvm.Volatile
@@ -77,6 +78,8 @@ interface YChat {
      */
     fun chatCompletions(): ChatCompletions
 
+    fun imageGenerations(): ImageGenerations
+
     /**
      * Callback is an interface used for handling the results of an operation.
      * It provides two methods, `onSuccess` and `onError`, for handling the success
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/data/api/ChatGptApi.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/data/api/ChatGptApi.kt
@@ -4,11 +4,15 @@ import co.yml.ychat.data.dto.ChatCompletionParamsDto
 import co.yml.ychat.data.dto.ChatCompletionsDto
 import co.yml.ychat.data.dto.CompletionDto
 import co.yml.ychat.data.dto.CompletionParamsDto
+import co.yml.ychat.data.dto.ImageGenerationsDto
+import co.yml.ychat.data.dto.ImageGenerationsParamsDto
 import co.yml.ychat.data.infrastructure.ApiResult
 
 internal interface ChatGptApi {
 
     suspend fun completion(paramsDto: CompletionParamsDto): ApiResult<CompletionDto>
 
     suspend fun chatCompletions(paramsDto: ChatCompletionParamsDto): ApiResult<ChatCompletionsDto>
+
+    suspend fun imageGenerations(paramsDto: ImageGenerationsParamsDto): ApiResult<ImageGenerationsDto>
 }
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/data/api/impl/ChatGptApiImpl.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/data/api/impl/ChatGptApiImpl.kt
@@ -5,6 +5,8 @@ import co.yml.ychat.data.dto.ChatCompletionParamsDto
 import co.yml.ychat.data.dto.ChatCompletionsDto
 import co.yml.ychat.data.dto.CompletionDto
 import co.yml.ychat.data.dto.CompletionParamsDto
+import co.yml.ychat.data.dto.ImageGenerationsDto
+import co.yml.ychat.data.dto.ImageGenerationsParamsDto
 import co.yml.ychat.data.infrastructure.ApiExecutor
 import co.yml.ychat.data.infrastructure.ApiResult
 import io.ktor.http.HttpMethod
@@ -26,4 +28,12 @@ internal class ChatGptApiImpl(private val apiExecutor: ApiExecutor) : ChatGptApi
             .setBody(paramsDto)
             .execute()
     }
+
+    override suspend fun imageGenerations(paramsDto: ImageGenerationsParamsDto): ApiResult<ImageGenerationsDto> {
+        return apiExecutor
+            .setEndpoint("v1/images/generations")
+            .setHttpMethod(HttpMethod.Post)
+            .setBody(paramsDto)
+            .execute()
+    }
 }
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/data/dto/ImageGenerationsDto.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/data/dto/ImageGenerationsDto.kt
@@ -0,0 +1,13 @@
+package co.yml.ychat.data.dto
+
+import co.yml.ychat.domain.model.ImageGenerated
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+internal data class ImageGenerationsDto(
+    @SerialName("created")
+    val created: Long,
+    @SerialName("data")
+    val data: List<ImageGenerated>,
+)
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/data/dto/ImageGenerationsParamsDto.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/data/dto/ImageGenerationsParamsDto.kt
@@ -0,0 +1,18 @@
+package co.yml.ychat.data.dto
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+internal data class ImageGenerationsParamsDto(
+    @SerialName("prompt")
+    val prompt: String,
+    @SerialName("n")
+    val results: Int,
+    @SerialName("size")
+    val size: String,
+    @SerialName("response_format")
+    val responseFormat: String,
+    @SerialName("user")
+    val user: String,
+)
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/di/module/LibraryModule.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/di/module/LibraryModule.kt
@@ -7,10 +7,13 @@ import co.yml.ychat.data.storage.ChatLogStorage
 import co.yml.ychat.di.provider.NetworkProvider
 import co.yml.ychat.domain.usecases.ChatCompletionsUseCase
 import co.yml.ychat.domain.usecases.CompletionUseCase
+import co.yml.ychat.domain.usecases.ImageGenerationsUseCase
 import co.yml.ychat.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
+import co.yml.ychat.entrypoint.features.ImageGenerations
 import co.yml.ychat.entrypoint.impl.ChatCompletionsImpl
 import co.yml.ychat.entrypoint.impl.CompletionImpl
+import co.yml.ychat.entrypoint.impl.ImageGenerationsImpl
 import kotlinx.coroutines.Dispatchers
 import org.koin.core.module.Module
 import org.koin.dsl.module
@@ -23,11 +26,13 @@ internal class LibraryModule(private val apiKey: String) {
     private val entrypointModule = module {
         factory<Completion> { CompletionImpl(Dispatchers.Default, get()) }
         factory<ChatCompletions> { ChatCompletionsImpl(Dispatchers.Default, get()) }
+        factory<ImageGenerations> { ImageGenerationsImpl(Dispatchers.Default, get()) }
     }
 
     private val domainModule = module {
         factory { CompletionUseCase(get(), get()) }
         factory { ChatCompletionsUseCase(get()) }
+        factory { ImageGenerationsUseCase(get()) }
     }
 
     private val dataModule = module {
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/domain/mapper/ImageGenerationsMapper.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/domain/mapper/ImageGenerationsMapper.kt
@@ -0,0 +1,23 @@
+package co.yml.ychat.domain.mapper
+
+import co.yml.ychat.data.dto.ImageGenerationsDto
+import co.yml.ychat.data.dto.ImageGenerationsParamsDto
+import co.yml.ychat.domain.model.ImageGenerated
+import co.yml.ychat.domain.model.ImageGenerationsParams
+
+internal fun ImageGenerationsDto.toImageGenerated(): List<ImageGenerated> {
+    return this.data.map {
+        ImageGenerated(it.url)
+    }
+}
+
+
+internal fun ImageGenerationsParams.toImageGenerationsParamsDto(): ImageGenerationsParamsDto {
+    return ImageGenerationsParamsDto(
+        prompt = this.prompt,
+        results = this.results,
+        size = this.size,
+        responseFormat = this.responseFormat,
+        user = this.user
+    )
+}
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/domain/model/ImageGenerated.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/domain/model/ImageGenerated.kt
@@ -0,0 +1,16 @@
+package co.yml.ychat.domain.model
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+/**
+ * Represents a message in a conversation, consisting of a [role] indicating the speaker
+ * (e.g., “system”, “user” or “assistant”), and the [content] of the message sent by the speaker.
+ * @property role The role of the speaker who sends the message.
+ * @property content The content of the message sent by the speaker.
+ */
+@Serializable
+data class ImageGenerated(
+    @SerialName("url")
+    val url: String,
+)
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/domain/model/ImageGenerationsParams.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/domain/model/ImageGenerationsParams.kt
@@ -0,0 +1,9 @@
+package co.yml.ychat.domain.model
+
+internal data class ImageGenerationsParams(
+    var prompt: String = "",
+    var results: Int = 2,
+    var size: String = "256x256",
+    var responseFormat: String = "url",
+    var user: String = "",
+)
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/domain/usecases/ImageGenerationsUseCase.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/domain/usecases/ImageGenerationsUseCase.kt
@@ -0,0 +1,16 @@
+package co.yml.ychat.domain.usecases
+
+import co.yml.ychat.data.api.ChatGptApi
+import co.yml.ychat.domain.mapper.toImageGenerated
+import co.yml.ychat.domain.mapper.toImageGenerationsParamsDto
+import co.yml.ychat.domain.model.ImageGenerated
+import co.yml.ychat.domain.model.ImageGenerationsParams
+
+internal data class ImageGenerationsUseCase(private val chatGptApi: ChatGptApi) {
+
+    suspend fun requestImageGenerations(params: ImageGenerationsParams): List<ImageGenerated> {
+        val requestDto = params.toImageGenerationsParamsDto()
+        val response = chatGptApi.imageGenerations(requestDto)
+        return response.getBodyOrThrow().toImageGenerated()
+    }
+}
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/features/ImageGenerations.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/features/ImageGenerations.kt
@@ -0,0 +1,20 @@
+package co.yml.ychat.entrypoint.features
+
+import co.yml.ychat.YChat
+import co.yml.ychat.data.exception.ChatGptException
+import co.yml.ychat.domain.model.ImageGenerated
+import kotlin.coroutines.cancellation.CancellationException
+
+interface ImageGenerations {
+
+    fun setResults(results: Int): ImageGenerations
+
+    fun setSize(size: String): ImageGenerations
+
+    fun setResponseFormat(responseFormat: String): ImageGenerations
+
+    @Throws(CancellationException::class, ChatGptException::class)
+    suspend fun execute(prompt: String): List<ImageGenerated>
+
+    fun execute(prompt: String, callback: YChat.Callback<List<String>>)
+}
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/impl/ImageGenerationsImpl.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/impl/ImageGenerationsImpl.kt
@@ -0,0 +1,52 @@
+package co.yml.ychat.entrypoint.impl
+
+import co.yml.ychat.YChat
+import co.yml.ychat.domain.model.ChatCompletionsParams
+import co.yml.ychat.domain.model.ImageGenerated
+import co.yml.ychat.domain.model.ImageGenerationsParams
+import co.yml.ychat.domain.usecases.ImageGenerationsUseCase
+import co.yml.ychat.entrypoint.features.ImageGenerations
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
+
+internal class ImageGenerationsImpl(
+    private val dispatcher: CoroutineDispatcher,
+    private val imageGenerationsUseCase: ImageGenerationsUseCase,
+) : ImageGenerations {
+
+    private val scope by lazy { CoroutineScope(SupervisorJob() + dispatcher) }
+
+    private var params: ImageGenerationsParams = ImageGenerationsParams()
+
+    override fun setResults(results: Int): ImageGenerations {
+        params.results = results
+        return this
+    }
+
+    override fun setSize(size: String): ImageGenerations {
+        params.size = size
+        return this
+    }
+
+    override fun setResponseFormat(responseFormat: String): ImageGenerations {
+        params.responseFormat = responseFormat
+        return this
+    }
+
+    override suspend fun execute(prompt: String): List<ImageGenerated> {
+        params.prompt = prompt
+        return imageGenerationsUseCase.requestImageGenerations(params)
+    }
+
+    override fun execute(prompt: String, callback: YChat.Callback<List<String>>) {
+        scope.launch {
+            kotlin.runCatching { execute(prompt) }
+                .onSuccess { it -> callback.onSuccess(it.map { it.url }) } // fix here
+                .onFailure { callback.onError(it) }
+        }
+    }
+
+
+}
diff --git a/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/impl/YChatImpl.kt b/ychat/src/commonMain/kotlin/co/yml/ychat/entrypoint/impl/YChatImpl.kt
@@ -4,6 +4,7 @@ import co.yml.ychat.YChat
 import co.yml.ychat.di.module.LibraryModule
 import co.yml.ychat.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
+import co.yml.ychat.entrypoint.features.ImageGenerations
 import org.koin.core.KoinApplication
 
 internal class YChatImpl(apiKey: String) : YChat {
@@ -22,4 +23,8 @@ internal class YChatImpl(apiKey: String) : YChat {
     override fun chatCompletions(): ChatCompletions {
         return koinApp.koin.get()
     }
+
+    override fun imageGenerations(): ImageGenerations {
+        return koinApp.koin.get()
+    }
 }
