refactor: code format and doc update

tddworks · Apr 18, 2024 · d625cb9 · d625cb9
1 parent 77eb1f1
commit d625cb9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -25,45 +25,50 @@ implementation("com.tddworks:openai-gateway-jvm:0.1.2")
 
 **Example:**
 ```kotlin
-import com.tddworks.anthropic.api.messages.api.AnthropicConfig
+import com.tddworks.anthropic.api.AnthropicConfig
+import com.tddworks.ollama.api.OllamaConfig
+import com.tddworks.ollama.api.OllamaModel
+import com.tddworks.openai.api.chat.api.ChatCompletionRequest
 import com.tddworks.openai.api.OpenAIConfig
+import com.tddworks.openai.api.chat.api.ChatMessage
+import com.tddworks.openai.api.chat.api.Model
 import com.tddworks.openai.gateway.api.OpenAIGateway
-import com.tddworks.openai.gateway.di.initOpenAIGatewayKoin
+import com.tddworks.openai.gateway.di.initOpenAIGateway
 
 val openAIGateway = initOpenAIGateway(
-    OpenAIConfig(
-        baseUrl = { "YOUR_OPENAI_BASE_URL" },
-        apiKey = { "YOUR_OPENAI_API_KEY" }
-    ),
-    AnthropicConfig(
-        baseUrl = { "YOUR_ANTHROPIC_BASE_URL" },
-        apiKey = { "YOUR_ANTHROPIC_API_KEY" },
-        anthropicVersion = { "YOUR_ANTHROPIC_VERSION" }
-    ),
-    OllamaConfig(
-        baseUrl = { "YOUR_OLLAMA_BASE_URL" },
-        protocol = { "YOUR_OLLAMA_PROTOCOL" },
-        port = { "YOUR_OLLAMA_PORT" }
+   OpenAIConfig(
+      baseUrl = { "YOUR_OPENAI_BASE_URL" },
+      apiKey = { "YOUR_OPENAI_API_KEY" }
+   ),
+   AnthropicConfig(
+      baseUrl = { "YOUR_ANTHROPIC_BASE_URL" },
+      apiKey = { "YOUR_ANTHROPIC_API_KEY" },
+      anthropicVersion = { "YOUR_ANTHROPIC_VERSION" }
+   ),
+   OllamaConfig(
+      baseUrl = { "YOUR_OLLAMA_BASE_URL" },
+      protocol = { "YOUR_OLLAMA_PROTOCOL" },
+      port = { "YOUR_OLLAMA_PORT" }
    )
 )
 
 // stream completions
 openAIGateway.streamCompletions(
-   OpenAIChatCompletionRequest(
+   ChatCompletionRequest(
       messages = listOf(ChatMessage.UserMessage("hello")),
       maxTokens = 1024,
-      model = OpenAIModel(OllamaModel.LLAMA2.value)
+      model = Model(OllamaModel.LLAMA2.value)
    )
 ).collect {
    println(it)
 }
 
 // chat completions
-val chatCompletion = gateway.completions(
-   OpenAIChatCompletionRequest(
+val chatCompletion = openAIGateway.completions(
+   ChatCompletionRequest(
       messages = listOf(ChatMessage.UserMessage("hello")),
       maxTokens = 1024,
-      model = OpenAIModel(Model.GPT_3_5_TURBO.value)
+      model = Model(Model.GPT_3_5_TURBO.value)
    )
 )
 ```
diff --git a/...gateway/openai-gateway-core/src/jvmTest/kotlin/com/tddworks/openai/gateway/di/KoinTest.kt b/...gateway/openai-gateway-core/src/jvmTest/kotlin/com/tddworks/openai/gateway/di/KoinTest.kt
@@ -1,6 +1,5 @@
 package com.tddworks.openai.gateway.di
 
-
 import com.tddworks.anthropic.api.AnthropicConfig
 import com.tddworks.ollama.api.OllamaConfig
 import com.tddworks.openai.api.OpenAIConfig