Merge pull request #57 from yml-org/feature/CM-1279/retrieve-model

[CM-1279] Implements retrieve model entrypoint

Author: osugikoji

README.md

@@ -86,6 +86,7 @@ try {
 ### Features
 
 - [ListModels](guides/Features.md#listmodels)
+- [RetrieveModel](guides/Features.md#retrieveModel)
 - [Completions](guides/Features.md#completion)
 - [ChatCompletions](guides/Features.md#chatcompletions)
 - [ImageGenerations](guides/Features.md#imagegenerations)

guides/Features.md

@@ -1,6 +1,7 @@
 # Features
 
 - [ListModels](#listModels)
+- [RetrieveModel](#retrieveModel)
 - [Completion](#completion)
 - [ChatCompletions](#chatcompletions)
 - [ImageGenerations](#imagegenerations)
@@ -39,6 +40,39 @@ try {
 }
 ```
 
+## RetrieveModel
+
+The retrieveModel api retrieve the currently model based on the given id, and provides basic information about it such as the owner and availability.
+
+### Swift
+
+```swift
+var yChat: YChat {
+    YChatCompanion.shared.create(apiKey: "your-api-key") 
+}
+
+do {
+  let result = try await yChat.retrieveModel().execute(id: "babbage")
+} catch {
+  // catch any error that may occurs on api call.  
+}
+```
+
+### Kotlin
+
+```kotlin
+val yChat by lazy {
+    YChat.create("your-api-key")
+}
+
+try {
+    val result = yChat.retrieveModel().execute("babbage")
+
+} catch (e: exception) {
+    // catch any error that may occurs on api call.  
+}
+```
+
 ## Completion
 
 The completions api can be used for a wide variety of tasks. You input some text as a prompt, and the model will generate a text completion that attempts to match whatever context or pattern you gave it. For example, if you give the API the prompt, "As Descartes said, I think, therefore", it will return the completion " I am" with high probability.
@@ -51,7 +85,7 @@ var yChat: YChat {
 }
 
 do {
-  let result = try await chatGpt.completion()
+  let result = try await yChat.completion()
                     .setInput(input: "Say this is a test.")
                     .setMaxTokens(tokens: 1024)
                     .set... // you can set more parameters
@@ -74,7 +108,6 @@ try {
         .setMaxTokens(1024)
         .set... // you can set more parameters
         .execute()
-
 } catch (e: exception) {
     // catch any error that may occurs on api call.  
 }
@@ -92,7 +125,7 @@ var yChat: YChat {
 }
 
 do {
-  let result = try await chatGpt.chatCompletions()
+  let result = try await yChat.chatCompletions()
                     .setMaxTokens(tokens: 1024)
                     .addMessage(
                         role: "assistant",
@@ -121,7 +154,6 @@ try {
         )
         .set... // you can set more parameters
         .execute("What is the best exercise for building muscle?")
-
 } catch (e: exception) {
     // catch any error that may occurs on api call.  
 }
@@ -139,7 +171,7 @@ var yChat: YChat {
 }
 
 do {
-  let result = try await chatGpt.imageGenerations()
+  let result = try await yChat.imageGenerations()
                     .setResults(results: 2)
                     .setSize(size: "1024x1024")
                     .set... // you can set more parameters
@@ -162,7 +194,6 @@ try {
         .setSize("1024x1024")
         .set... // you can set more parameters
         .execute("ocean")
-
 } catch (e: exception) {
     // catch any error that may occurs on api call.  
 }
@@ -180,7 +211,7 @@ var yChat: YChat {
 }
 
 do {
-  let result = try await chatGpt.edits()
+  let result = try await yChat.edits()
                     .setInput(input: "What day of the wek is it?")
                     .setResults(result: 1)
                     .set... // you can set more parameters
@@ -203,7 +234,6 @@ try {
         .setResults(1)
         .set... // you can set more parameters
         .execute("Fix the spelling mistakes")
-
 } catch (e: exception) {
     // catch any error that may occurs on api call.  
 }

sample/jvm/README.md

@@ -81,4 +81,14 @@ This endpoint retrieve a list of currently available artificial intelligence mod
 
 ##### Example:
 
-`GET http://localhost:8080/api/ychat/models`
+`GET http://localhost:8080/api/ychat/models`
+
+### Model Endpoint
+
+This endpoint retrieve the artificial intelligence model based on the given ID.
+
+##### Endpoint: http://localhost:[port_number]/api/ychat/models/{modelID}
+
+##### Example:
+
+`GET http://localhost:8080/api/ychat/models/babbage`

sample/jvm/src/main/java/co/yml/ychat/jvm/controller/YChatController.java

@@ -6,6 +6,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
@@ -57,6 +58,12 @@ public ResponseEntity<List<AIModel>> models() throws Exception {
         return ResponseEntity.ok(result);
     }
 
+    @GetMapping("models/{id}")
+    public ResponseEntity<AIModel> model(@PathVariable String id) throws Exception {
+        AIModel result = YChatService.getModel(id);
+        return ResponseEntity.ok(result);
+    }
+
     private static class Defaults {
         static final String COMPLETION_INPUT = "Say this is a test.";
         static final String CHAT_COMPLETION_INPUT = "Tell me one strength exercise";

sample/jvm/src/main/java/co/yml/ychat/jvm/services/YChatService.java

@@ -1,13 +1,13 @@
 package co.yml.ychat.jvm.services;
 
+import co.yml.ychat.YChat;
 import co.yml.ychat.domain.model.AIModel;
 import co.yml.ychat.domain.model.ChatMessage;
 import java.util.List;
+import java.util.concurrent.CompletableFuture;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
-import java.util.concurrent.CompletableFuture;
-import co.yml.ychat.YChat;
 
 @Service
 public class YChatService {
@@ -58,6 +58,13 @@ public List<AIModel> getModels() throws Exception {
         return future.get();
     }
 
+    public AIModel getModel(String id) throws Exception {
+        final CompletableFuture<AIModel> future = new CompletableFuture<>();
+        ychat.retrieveModel()
+                .execute(id, new CompletionCallbackResult<>(future));
+        return future.get();
+    }
+
     private static class CompletionCallbackResult<T> implements YChat.Callback<T> {
 
         private final CompletableFuture<T> future;

ychat/src/commonMain/kotlin/co/yml/ychat/YChat.kt

@@ -5,6 +5,7 @@ import co.yml.ychat.entrypoint.features.Completion
 import co.yml.ychat.entrypoint.features.Edits
 import co.yml.ychat.entrypoint.features.ImageGenerations
 import co.yml.ychat.entrypoint.features.ListModels
+import co.yml.ychat.entrypoint.features.RetrieveModel
 import co.yml.ychat.entrypoint.impl.YChatImpl
 import kotlin.jvm.JvmStatic
 import kotlin.jvm.Volatile
@@ -32,6 +33,19 @@ interface YChat {
      */
     fun listModels(): ListModels
 
+    /**
+     * The retrieveModel api retrieve the currently model based on the given id, and provides basic
+     * information about it such as the owner and availability.
+     *
+     * Example usage:
+     * ```
+     * val result = YChat.create(apiKey)
+     *      .retrieveModel()
+     *      .execute("gpt-3")
+     * ```
+     */
+    fun retrieveModel(): RetrieveModel
+
     /**
      * The completions api can be used for a wide variety of tasks. You input some text as a
      * prompt, and the model will generate a text completion that attempts to match whatever

ychat/src/commonMain/kotlin/co/yml/ychat/data/api/ChatGptApi.kt

@@ -8,6 +8,7 @@ import co.yml.ychat.data.dto.EditsDto
 import co.yml.ychat.data.dto.EditsParamsDto
 import co.yml.ychat.data.dto.ImageGenerationsDto
 import co.yml.ychat.data.dto.ImageGenerationsParamsDto
+import co.yml.ychat.data.dto.ModelDto
 import co.yml.ychat.data.dto.ModelListDto
 import co.yml.ychat.data.infrastructure.ApiResult
 
@@ -22,4 +23,6 @@ internal interface ChatGptApi {
     suspend fun edits(paramsDto: EditsParamsDto): ApiResult<EditsDto>
 
     suspend fun models(): ApiResult<ModelListDto>
+
+    suspend fun model(id: String): ApiResult<ModelDto>
 }

ychat/src/commonMain/kotlin/co/yml/ychat/data/api/impl/ChatGptApiImpl.kt

@@ -9,6 +9,7 @@ import co.yml.ychat.data.dto.EditsDto
 import co.yml.ychat.data.dto.EditsParamsDto
 import co.yml.ychat.data.dto.ImageGenerationsDto
 import co.yml.ychat.data.dto.ImageGenerationsParamsDto
+import co.yml.ychat.data.dto.ModelDto
 import co.yml.ychat.data.dto.ModelListDto
 import co.yml.ychat.data.infrastructure.ApiExecutor
 import co.yml.ychat.data.infrastructure.ApiResult
@@ -54,4 +55,11 @@ internal class ChatGptApiImpl(private val apiExecutor: ApiExecutor) : ChatGptApi
             .setHttpMethod(HttpMethod.Get)
             .execute()
     }
+
+    override suspend fun model(id: String): ApiResult<ModelDto> {
+        return apiExecutor
+            .setEndpoint("v1/models/$id")
+            .setHttpMethod(HttpMethod.Get)
+            .execute()
+    }
 }

ychat/src/commonMain/kotlin/co/yml/ychat/di/module/LibraryModule.kt

@@ -10,16 +10,19 @@ import co.yml.ychat.domain.usecases.CompletionUseCase
 import co.yml.ychat.domain.usecases.EditsUseCase
 import co.yml.ychat.domain.usecases.ImageGenerationsUseCase
 import co.yml.ychat.domain.usecases.ListModelsUseCase
+import co.yml.ychat.domain.usecases.RetrieveModelUseCase
 import co.yml.ychat.entrypoint.features.ChatCompletions
 import co.yml.ychat.entrypoint.features.Completion
 import co.yml.ychat.entrypoint.features.Edits
 import co.yml.ychat.entrypoint.features.ImageGenerations
 import co.yml.ychat.entrypoint.features.ListModels
+import co.yml.ychat.entrypoint.features.RetrieveModel
 import co.yml.ychat.entrypoint.impl.ChatCompletionsImpl
 import co.yml.ychat.entrypoint.impl.CompletionImpl
 import co.yml.ychat.entrypoint.impl.EditsImpl
 import co.yml.ychat.entrypoint.impl.ImageGenerationsImpl
 import co.yml.ychat.entrypoint.impl.ListModelsImpl
+import co.yml.ychat.entrypoint.impl.RetrieveModelImpl
 import kotlinx.coroutines.Dispatchers
 import org.koin.core.module.Module
 import org.koin.dsl.module
@@ -31,6 +34,7 @@ internal class LibraryModule(private val apiKey: String) {
 
     private val entrypointModule = module {
         factory<ListModels> { ListModelsImpl(Dispatchers.Default, get()) }
+        factory<RetrieveModel> { RetrieveModelImpl(Dispatchers.Default, get()) }
         factory<Completion> { CompletionImpl(Dispatchers.Default, get()) }
         factory<ChatCompletions> { ChatCompletionsImpl(Dispatchers.Default, get()) }
         factory<ImageGenerations> { ImageGenerationsImpl(Dispatchers.Default, get()) }
@@ -39,6 +43,7 @@ internal class LibraryModule(private val apiKey: String) {
 
     private val domainModule = module {
         factory { ListModelsUseCase(get()) }
+        factory { RetrieveModelUseCase(get()) }
         factory { CompletionUseCase(get(), get()) }
         factory { ChatCompletionsUseCase(get()) }
         factory { ImageGenerationsUseCase(get()) }

ychat/src/commonMain/kotlin/co/yml/ychat/domain/usecases/ChatCompletionsUseCase.kt

@@ -6,7 +6,7 @@ import co.yml.ychat.domain.mapper.toChatMessages
 import co.yml.ychat.domain.model.ChatCompletionsParams
 import co.yml.ychat.domain.model.ChatMessage
 
-internal data class ChatCompletionsUseCase(private val chatGptApi: ChatGptApi) {
+internal class ChatCompletionsUseCase(private val chatGptApi: ChatGptApi) {
 
     suspend fun requestChatCompletions(params: ChatCompletionsParams): List<ChatMessage> {
         val requestDto = params.toChatCompletionParamsDto()