Spaces:
Running
Running
| { | |
| "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" | |
| } |