File size: 4,612 Bytes
b3dbd3c
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
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"
}