update path and openapi 3 json

app.py

@@ -47,23 +47,42 @@ query_parser.add_argument(
 
 
 @api.route(
-    "/get_related_docs/<string:knowledge_base>",
+    "/get_related_arxiv",
     doc={
         "description": (
             "Get some related papers.\nYou should use schema here:\n\n"
             "CREATE TABLE ArXiv (\n"
             "    `id` String,\n"
-            "    `abstract` String, -- abstract of the paper. avoid using this column to do LIKE match\n"
+            "    `abstract` String, \n"
             "    `pubdate` DateTime, \n"
-            "    `title` String, -- title of the paper\n"
-            "    `categories` Array(String), -- arxiv category of the paper\n"
-            "    `authors` Array(String), -- authors of the paper\n"
-            "    `comment` String, -- extra comments of the paper\n"
+            "    `title` String, \n"
+            "    `categories` Array(String), -- arxiv category\n"
+            "    `authors` Array(String),\n"
+            "    `comment` String,\n"
             "ORDER BY id\n\n"
+        ),
+    },
+)
+class get_related_arxiv(Resource):
+    @api.expect(query_parser)
+    @api.marshal_with(query_result)
+    @api.doc(id='get_related_arxiv')
+    def get(self):
+        args = query_parser.parse_args()
+        kb = kb_list['arxiv']()
+        docs, num_docs = kb(args.subject, args.where_str, args.limit)
+        return {"documents": docs, "num_retrieved": num_docs}
+
+
+@api.route(
+    "/get_related_wiki",
+    doc={
+        "description": (
+            "Get some related wiki pages.\nYou should use schema here:\n\n"
             "CREATE TABLE Wikipedia (\n"
             "    `id` String,\n"
-            "    `text` String, -- abstract of the wiki page. avoid using this column to do LIKE match\n"
-            "    `title` String, -- title of the paper\n"
+            "    `text` String,\n"
+            "    `title` String,\n"
             "    `view` Float32,\n"
             "    `url` String, -- URL to this wiki page\n"
             "ORDER BY id\n\n"
@@ -71,15 +90,13 @@ query_parser.add_argument(
         ),
     },
 )
-@api.param("knowledge_base", "Knowledge base used to query. Must be one of ['wiki', 'arxiv']")
-class get_related_docs(Resource):
+class get_related_wiki(Resource):
     @api.expect(query_parser)
     @api.marshal_with(query_result)
-    def get(self, knowledge_base):
+    @api.doc(id='get_related_wiki')
+    def get(self):
         args = query_parser.parse_args()
-        kb = kb_list[knowledge_base]()
-        print(kb)
-        print(args.subject, args.where_str, args.limit)
+        kb = kb_list['wiki']()
         docs, num_docs = kb(args.subject, args.where_str, args.limit)
         return {"documents": docs, "num_retrieved": num_docs}
 

openapi.json

@@ -0,0 +1,166 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "MyScale Open Knowledge Base",
+    "description": "An API to get relevant page from MyScale Open Knowledge Base",
+    "termsOfService": "https://myscale.com/terms/",
+    "version": "0.1"
+  },
+  "servers": [
+    {
+      "url": "https://myscale-gpts-myscale-backend.hf.space"
+    }
+  ],
+  "tags": [
+    {
+      "name": "default",
+      "description": "Default namespace"
+    }
+  ],
+  "paths": {
+    "/get_related_arxiv": {
+      "get": {
+        "tags": [
+          "default"
+        ],
+        "description": "Get some related papers.\nYou should use schema here:\n\nCREATE TABLE ArXiv (\n    `id` String,\n    `abstract` String, \n    `pubdate` DateTime, \n    `title` String, \n    `categories` Array(String), -- arxiv category\n    `authors` Array(String),\n    `comment` String,\nORDER BY id",
+        "operationId": "get_related_arxiv",
+        "parameters": [
+          {
+            "name": "subject",
+            "in": "query",
+            "description": "a sentence or phrase describes the subject you want to query.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "where_str",
+            "in": "query",
+            "description": "a sql-like where string to build filter",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "desired number of retrieved documents",
+            "schema": {
+              "type": "integer",
+              "default": 4
+            }
+          },
+          {
+            "name": "X-Fields",
+            "in": "header",
+            "description": "An optional fields mask",
+            "schema": {
+              "type": "string",
+              "format": "mask"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/QueryResult"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/get_related_wiki": {
+      "get": {
+        "tags": [
+          "default"
+        ],
+        "description": "Get some related wiki pages.\nYou should use schema here:\n\nCREATE TABLE Wikipedia (\n    `id` String,\n    `text` String,\n    `title` String,\n    `view` Float32,\n    `url` String, -- URL to this wiki page\nORDER BY id\n\nYou should avoid using LIKE on long text columns.",
+        "operationId": "get_related_wiki",
+        "parameters": [
+          {
+            "name": "subject",
+            "in": "query",
+            "description": "a sentence or phrase describes the subject you want to query.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "where_str",
+            "in": "query",
+            "description": "a sql-like where string to build filter",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "desired number of retrieved documents",
+            "schema": {
+              "type": "integer",
+              "default": 4
+            }
+          },
+          {
+            "name": "X-Fields",
+            "in": "header",
+            "description": "An optional fields mask",
+            "schema": {
+              "type": "string",
+              "format": "mask"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/QueryResult"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "QueryResult": {
+        "type": "object",
+        "properties": {
+          "documents": {
+            "type": "string"
+          },
+          "num_retrieved": {
+            "type": "integer"
+          }
+        }
+      }
+    },
+    "responses": {
+      "ParseError": {
+        "description": "When a mask can't be parsed",
+        "content": {}
+      },
+      "MaskError": {
+        "description": "When any error occurs on mask",
+        "content": {}
+      }
+    }
+  },
+  "x-original-swagger-version": "2.0"
+}