Split RAG and RaaG

dRAGon-Okinawa · Jun 6, 2024 · 35bef75 · 35bef75
1 parent e3f5dd1
commit 35bef75
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 30 deletions.
diff --git a/backend/build.gradle b/backend/build.gradle
@@ -61,9 +61,10 @@ application {
 }
 
 openApi {
-	groupedApiMappings.set(['http://localhost:1985/api/docs/backendapi': 'swagger-backendapi.json',
-                            'http://localhost:1985/api/docs/publicapi': 'swagger-publicapi.json',
-							'http://localhost:1985/api/docs/ragapi': 'swagger-ragapi.json'])
+	groupedApiMappings.set(['http://localhost:1985/api/docs/backend': 'swagger-backend.json',
+                            'http://localhost:1985/api/docs/app': 'swagger-app.json',
+							'http://localhost:1985/api/docs/rag': 'swagger-rag.json',
+							'http://localhost:1985/api/docs/raag': 'swagger-raag.json'])
     outputDir.set(file("$buildDir/docs"))
     waitTimeInSeconds.set(10)
     customBootRun {

diff --git a/backend/src/main/java/ai/dragon/config/SwaggerConfig.java b/backend/src/main/java/ai/dragon/config/SwaggerConfig.java
@@ -13,26 +13,34 @@
 @Configuration
 public class SwaggerConfig {
     @Bean
-    public GroupedOpenApi publicApi() {
+    public GroupedOpenApi app() {
         return GroupedOpenApi.builder()
-                .group("publicapi")
-                .pathsToMatch("/api/publicapi/**")
+                .group("app")
+                .pathsToMatch("/api/app/**")
                 .build();
     }
 
     @Bean
-    public GroupedOpenApi backendApi() {
+    public GroupedOpenApi backend() {
         return GroupedOpenApi.builder()
-                .group("backendapi")
-                .pathsToMatch("/api/backendapi/**")
+                .group("backend")
+                .pathsToMatch("/api/backend/**")
                 .build();
     }
 
     @Bean
-    public GroupedOpenApi ragApi() {
+    public GroupedOpenApi rag() {
         return GroupedOpenApi.builder()
-                .group("ragapi")
-                .pathsToMatch("/api/ragapi/**")
+                .group("rag")
+                .pathsToMatch("/api/rag/**")
+                .build();
+    }
+
+    @Bean
+    public GroupedOpenApi raag() {
+        return GroupedOpenApi.builder()
+                .group("raag")
+                .pathsToMatch("/api/raag/**")
                 .build();
     }
 

diff --git a/...pi/publicapi/HealthOpenApiController.java → ...ller/api/app/HealthOpenApiController.java b/...pi/publicapi/HealthOpenApiController.java → ...ller/api/app/HealthOpenApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.publicapi;
+package ai.dragon.controller.api.app;
 
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -9,7 +9,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 @RestController
-@RequestMapping("/api/publicapi/health")
+@RequestMapping("/api/app/health")
 @Tag(name = "Health", description = "Health Check API Endpoints")
 public class HealthOpenApiController {
     @GetMapping("/status")

diff --git a/.../DatabaseCommandBackendApiController.java → .../DatabaseCommandBackendApiController.java b/.../DatabaseCommandBackendApiController.java → .../DatabaseCommandBackendApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.backendapi.command;
+package ai.dragon.controller.api.backend.command;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -12,7 +12,7 @@
 import jakarta.servlet.http.HttpServletResponse;
 
 @RestController
-@RequestMapping("/api/backendapi/command/database")
+@RequestMapping("/api/backend/command/database")
 @Tag(name = "Database Command", description = "Database Command API Endpoints")
 public class DatabaseCommandBackendApiController {
     @Autowired

diff --git a/...mand/SiloCommandBackendApiController.java → ...mand/SiloCommandBackendApiController.java b/...mand/SiloCommandBackendApiController.java → ...mand/SiloCommandBackendApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.backendapi.command;
+package ai.dragon.controller.api.backend.command;
 
 import java.util.UUID;
 
@@ -15,7 +15,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 @RestController
-@RequestMapping("/api/backendapi/command/silo")
+@RequestMapping("/api/backend/command/silo")
 @Tag(name = "Silo Command", description = "Silo Command API Endpoints")
 public class SiloCommandBackendApiController {
     @Autowired

diff --git a/...ory/AbstractCrudBackendApiController.java → ...ory/AbstractCrudBackendApiController.java b/...ory/AbstractCrudBackendApiController.java → ...ory/AbstractCrudBackendApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.backendapi.repository;
+package ai.dragon.controller.api.backend.repository;
 
 import java.lang.reflect.Constructor;
 import java.util.List;

diff --git a/.../repository/FarmBackendApiController.java → .../repository/FarmBackendApiController.java b/.../repository/FarmBackendApiController.java → .../repository/FarmBackendApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.backendapi.repository;
+package ai.dragon.controller.api.backend.repository;
 
 import java.util.List;
 import java.util.Map;
@@ -24,7 +24,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 @RestController
-@RequestMapping("/api/backendapi/repository/farm")
+@RequestMapping("/api/backend/repository/farm")
 @Tag(name = "Farm Repository", description = "Farm Repository Management API Endpoints")
 public class FarmBackendApiController extends AbstractCrudBackendApiController<FarmEntity> {
     @Autowired

diff --git a/.../repository/SiloBackendApiController.java → .../repository/SiloBackendApiController.java b/.../repository/SiloBackendApiController.java → .../repository/SiloBackendApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.backendapi.repository;
+package ai.dragon.controller.api.backend.repository;
 
 import java.util.List;
 import java.util.Map;
@@ -26,7 +26,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 @RestController
-@RequestMapping("/api/backendapi/repository/silo")
+@RequestMapping("/api/backend/repository/silo")
 @Tag(name = "Silo Repository", description = "Silo Repository Management API Endpoints")
 public class SiloBackendApiController extends AbstractCrudBackendApiController<SiloEntity> {
     @Autowired

diff --git a/...gapi/OpenAiCompatibleV1ApiController.java → ...raag/OpenAiCompatibleV1ApiController.java b/...gapi/OpenAiCompatibleV1ApiController.java → ...raag/OpenAiCompatibleV1ApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.ragapi;
+package ai.dragon.controller.api.raag;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -24,7 +24,7 @@
 import jakarta.validation.Valid;
 
 @RestController
-@RequestMapping("/api/ragapi/v1")
+@RequestMapping("/api/raag/v1")
 @Tag(name = "Open AI Compatible", description = "Compatible Endpoints following Open AI API Format")
 public class OpenAiCompatibleV1ApiController {
     @Autowired

diff --git a/...er/api/ragapi/SearchRagApiController.java → ...oller/api/rag/SearchRagApiController.java b/...er/api/ragapi/SearchRagApiController.java → ...oller/api/rag/SearchRagApiController.java
@@ -1,4 +1,4 @@
-package ai.dragon.controller.api.ragapi;
+package ai.dragon.controller.api.rag;
 
 import java.util.List;
 import java.util.UUID;
@@ -22,7 +22,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 @RestController
-@RequestMapping("/api/ragapi/search")
+@RequestMapping("/api/rag/search")
 @Tag(name = "Ask", description = "Search API Endpoints")
 public class SearchRagApiController {
     @Autowired

diff --git a/docs/docs/commands/database-export.mdx b/docs/docs/commands/database-export.mdx
@@ -32,5 +32,5 @@ docker run -v /path/to/output:/output dragon --command=database-export --output=
 ## Online Export
 To export the database while the backend server is running, use the following API endpoint:
 ```bash
-curl -X 'POST' 'http://localhost:1985/api/backendapi/command/database/database/export'
+curl -X 'POST' 'http://localhost:1985/api/backend/command/database/database/export'
 ```
diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx
@@ -17,8 +17,7 @@ Let's discover **dRAGon in less than 5 minutes**.
 
 ### Docker
 ```shell
-docker pull ghcr.io/dragon-okinawa/dragon:latest
-docker run -d -p 1985:1985 -v $(pwd)/data:/data --name dragon ghcr.io/dragon-okinawa/dragon:latest
+docker run --rm -p 1985:1985 -v $(pwd)/data:/data --name dragon ghcr.io/dragon-okinawa/dragon:latest
 ```
 
 ### Gradle