waii-sdk-js
Advanced tools
Comparing version 1.10.2 to 1.11.0
@@ -0,8 +1,11 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
type KeysList = { | ||
access_keys: string[]; | ||
}; | ||
export declare let AccessKey: { | ||
getKeys: () => Promise<KeysList>; | ||
}; | ||
declare class AccessKey { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
getKeys(): Promise<KeysList>; | ||
} | ||
export default AccessKey; | ||
export { KeysList }; |
@@ -11,16 +11,15 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.AccessKey = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
const GENERATE_ENDPOINT = 'get-access-key'; | ||
exports.AccessKey = (function () { | ||
return { | ||
getKeys: () => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GENERATE_ENDPOINT, {}); | ||
}) | ||
}; | ||
})(); | ||
exports.default = exports.AccessKey; | ||
class AccessKey { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
getKeys() { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GENERATE_ENDPOINT, {}); | ||
}); | ||
} | ||
} | ||
; | ||
exports.default = AccessKey; |
@@ -0,1 +1,2 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
type OAuthConfiguration = { | ||
@@ -12,6 +13,8 @@ oauth_provider: string; | ||
type CommonResponse = {}; | ||
export declare let Authorization: { | ||
authorize: (params: AuthRequest, signal?: AbortSignal) => Promise<CommonResponse>; | ||
}; | ||
declare class Authorization { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
authorize(params: AuthRequest, signal?: AbortSignal): Promise<CommonResponse>; | ||
} | ||
export default Authorization; | ||
export { AuthRequest }; |
@@ -11,16 +11,17 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.Authorization = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
const O_AUTH_ENDPOINT = 'configure-oauth'; | ||
exports.Authorization = (function () { | ||
return { | ||
authorize: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(O_AUTH_ENDPOINT, params, signal); | ||
}), | ||
}; | ||
})(); | ||
exports.default = exports.Authorization; | ||
class Authorization { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
; | ||
authorize(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(O_AUTH_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
} | ||
; | ||
exports.default = Authorization; |
@@ -0,1 +1,2 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
declare enum DBContentFilterScope { | ||
@@ -138,12 +139,14 @@ schema = "schema", | ||
}; | ||
export declare let Database: { | ||
modifyConnections: (params: ModifyDBConnectionRequest, signal?: AbortSignal) => Promise<ModifyDBConnectionResponse>; | ||
getConnections: (params?: GetDBConnectionRequest, signal?: AbortSignal) => Promise<GetDBConnectionResponse>; | ||
activateConnection: (key: string, signal?: AbortSignal) => Promise<GetDBConnectionResponse>; | ||
getCatalogs: (params?: GetCatalogRequest, signal?: AbortSignal) => Promise<GetCatalogResponse>; | ||
getDefaultConnection: () => string; | ||
updateTableDescription: (params: UpdateTableDescriptionRequest, signal?: AbortSignal) => Promise<ModifyDBConnectionResponse>; | ||
updateSchemaDescription: (params: UpdateSchemaDescriptionRequest, signal?: AbortSignal) => Promise<ModifyDBConnectionResponse>; | ||
}; | ||
declare class Database { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
modifyConnections(params: ModifyDBConnectionRequest, signal?: AbortSignal): Promise<ModifyDBConnectionResponse>; | ||
getConnections(params?: GetDBConnectionRequest, signal?: AbortSignal): Promise<GetDBConnectionResponse>; | ||
activateConnection(key: string, signal?: AbortSignal): Promise<GetDBConnectionResponse>; | ||
getCatalogs(params?: GetCatalogRequest, signal?: AbortSignal): Promise<GetCatalogResponse>; | ||
getDefaultConnection(): string; | ||
updateTableDescription(params: UpdateTableDescriptionRequest, signal?: AbortSignal): Promise<ModifyDBConnectionResponse>; | ||
updateSchemaDescription(params: UpdateSchemaDescriptionRequest, signal?: AbortSignal): Promise<ModifyDBConnectionResponse>; | ||
} | ||
export default Database; | ||
export { DBConnection, Catalog, Schema, Table, SchemaName, TableName, TableDescriptionPair, TableReference, SchemaDescription, SearchContext, Column, ColumnSampleValues, GetDBConnectionRequest, GetDBConnectionResponse, ModifyDBConnectionRequest, ModifyDBConnectionResponse, GetCatalogRequest, GetCatalogResponse, DBConnectionIndexingStatus, SchemaIndexingStatus, DBContentFilter, DBContentFilterScope, DBContentFilterType }; |
@@ -11,8 +11,4 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.DBContentFilterType = exports.DBContentFilterScope = exports.Database = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
exports.DBContentFilterType = exports.DBContentFilterScope = void 0; | ||
const MODIFY_DB_ENDPOINT = 'update-db-connect-info'; | ||
@@ -28,2 +24,3 @@ const GET_CATALOG_ENDPOINT = 'get-table-definitions'; | ||
})(DBContentFilterScope || (exports.DBContentFilterScope = DBContentFilterScope = {})); | ||
; | ||
var DBContentFilterType; | ||
@@ -34,31 +31,51 @@ (function (DBContentFilterType) { | ||
})(DBContentFilterType || (exports.DBContentFilterType = DBContentFilterType = {})); | ||
exports.Database = (function () { | ||
return { | ||
modifyConnections: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(MODIFY_DB_ENDPOINT, params, signal); | ||
}), | ||
getConnections: (params = {}, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(MODIFY_DB_ENDPOINT, params, signal); | ||
}), | ||
activateConnection: (key, signal) => __awaiter(this, void 0, void 0, function* () { | ||
WaiiHttpClient_1.default.getInstance().setScope(key); | ||
let result = yield WaiiHttpClient_1.default.getInstance().commonFetch(MODIFY_DB_ENDPOINT, { | ||
; | ||
class Database { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
modifyConnections(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(MODIFY_DB_ENDPOINT, params, signal); | ||
}); | ||
} | ||
getConnections(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(MODIFY_DB_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
activateConnection(key, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
this.httpClient.setScope(key); | ||
let result = yield this.httpClient.commonFetch(MODIFY_DB_ENDPOINT, { | ||
default_db_connection_key: key | ||
}, signal); | ||
return result; | ||
}), | ||
getCatalogs: (params = {}, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GET_CATALOG_ENDPOINT, params, signal); | ||
}), | ||
getDefaultConnection: () => { | ||
return WaiiHttpClient_1.default.getInstance().getScope(); | ||
}, | ||
updateTableDescription: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(UPDATE_TABLE_DESCRIPTION_ENDPOINT, params, signal); | ||
}), | ||
updateSchemaDescription: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(UPDATE_SCHEMA_DESCRIPTION_ENDPOINT, params, signal); | ||
}) | ||
}; | ||
})(); | ||
exports.default = exports.Database; | ||
}); | ||
} | ||
; | ||
getCatalogs(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GET_CATALOG_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
getDefaultConnection() { | ||
return this.httpClient.getScope(); | ||
} | ||
; | ||
updateTableDescription(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(UPDATE_TABLE_DESCRIPTION_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
updateSchemaDescription(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(UPDATE_SCHEMA_DESCRIPTION_ENDPOINT, params, signal); | ||
}); | ||
} | ||
} | ||
; | ||
exports.default = Database; |
@@ -1,4 +0,7 @@ | ||
export declare let HealthCheck: { | ||
healthCheck: () => Promise<any>; | ||
}; | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
declare class HealthCheck { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
healthCheck(): Promise<any>; | ||
} | ||
export default HealthCheck; |
@@ -11,16 +11,16 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.HealthCheck = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
const HEALTH_CHECK_ENDPOINT = 'health-check'; | ||
exports.HealthCheck = (function () { | ||
return { | ||
healthCheck: () => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(HEALTH_CHECK_ENDPOINT, {}); | ||
}) | ||
}; | ||
})(); | ||
exports.default = exports.HealthCheck; | ||
class HealthCheck { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
healthCheck() { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(HEALTH_CHECK_ENDPOINT, {}); | ||
}); | ||
} | ||
; | ||
} | ||
; | ||
exports.default = HealthCheck; |
@@ -0,1 +1,2 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
import { GeneratedQuery, QueryGenerationRequest } from "../../query/src/Query"; | ||
@@ -13,6 +14,8 @@ type GeneratedQueryHistoryEntry = { | ||
}; | ||
export declare let History: { | ||
list: (params?: GetGeneratedQueryHistoryRequest, signal?: AbortSignal) => Promise<GetGeneratedQueryHistoryResponse>; | ||
}; | ||
declare class History { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
list(params?: GetGeneratedQueryHistoryRequest, signal?: AbortSignal): Promise<GetGeneratedQueryHistoryResponse>; | ||
} | ||
export default History; | ||
export { GeneratedQueryHistoryEntry, GetGeneratedQueryHistoryRequest, GetGeneratedQueryHistoryResponse, GeneratedQuery }; |
@@ -11,16 +11,17 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.History = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
const GET_ENDPOINT = 'get-generated-query-history'; | ||
exports.History = (function () { | ||
return { | ||
list: (params = {}, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GET_ENDPOINT, params, signal); | ||
}) | ||
}; | ||
})(); | ||
exports.default = exports.History; | ||
class History { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
; | ||
list(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GET_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
} | ||
; | ||
exports.default = History; |
@@ -0,1 +1,2 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
import { SearchContext, TableName, Column, SchemaName } from "../../database/src/Database"; | ||
@@ -124,17 +125,19 @@ import { SemanticStatement } from "../../semantic-context/src/SemanticContext"; | ||
}; | ||
export declare let Query: { | ||
generate: (params: QueryGenerationRequest, signal?: AbortSignal) => Promise<GeneratedQuery>; | ||
transcode: (params: TranscodeQueryRequest, signal?: AbortSignal) => Promise<GeneratedQuery>; | ||
run: (params: RunQueryRequest, signal?: AbortSignal) => Promise<GetQueryResultResponse>; | ||
like: (params: LikeQueryRequest, signal?: AbortSignal) => Promise<LikeQueryResponse>; | ||
submit: (params: RunQueryRequest, signal?: AbortSignal) => Promise<RunQueryResponse>; | ||
getResults: (params: GetQueryResultRequest, signal?: AbortSignal) => Promise<GetQueryResultResponse>; | ||
cancel: (params: CancelQueryRequest, signal?: AbortSignal) => Promise<CancelQueryResponse>; | ||
describe: (params: DescribeQueryRequest, signal?: AbortSignal) => Promise<DescribeQueryResponse>; | ||
autoComplete: (params: AutoCompleteRequest, signal?: AbortSignal) => Promise<AutoCompleteResponse>; | ||
diff: (params: DiffQueryRequest, signal?: AbortSignal) => Promise<DiffQueryResponse>; | ||
analyzePerformance: (params: QueryPerformanceRequest, signal?: AbortSignal) => Promise<QueryPerformanceResponse>; | ||
generateQuestion: (params: GenerateQuestionRequest, signal?: AbortSignal) => Promise<GenerateQuestionResponse>; | ||
}; | ||
declare class Query { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
generate(params: QueryGenerationRequest, signal?: AbortSignal): Promise<GeneratedQuery>; | ||
transcode(params: TranscodeQueryRequest, signal?: AbortSignal): Promise<GeneratedQuery>; | ||
run(params: RunQueryRequest, signal?: AbortSignal): Promise<GetQueryResultResponse>; | ||
like(params: LikeQueryRequest, signal?: AbortSignal): Promise<LikeQueryResponse>; | ||
submit(params: RunQueryRequest, signal?: AbortSignal): Promise<RunQueryResponse>; | ||
getResults(params: GetQueryResultRequest, signal?: AbortSignal): Promise<GetQueryResultResponse>; | ||
cancel(params: CancelQueryRequest, signal?: AbortSignal): Promise<CancelQueryResponse>; | ||
describe(params: DescribeQueryRequest, signal?: AbortSignal): Promise<DescribeQueryResponse>; | ||
autoComplete(params: AutoCompleteRequest, signal?: AbortSignal): Promise<AutoCompleteResponse>; | ||
diff(params: DiffQueryRequest, signal?: AbortSignal): Promise<DiffQueryResponse>; | ||
analyzePerformance(params: QueryPerformanceRequest, signal?: AbortSignal): Promise<QueryPerformanceResponse>; | ||
generateQuestion(params: GenerateQuestionRequest, signal?: AbortSignal): Promise<GenerateQuestionResponse>; | ||
} | ||
export default Query; | ||
export { GetQueryResultRequest, GetQueryResultResponse, GeneratedQuery, QueryGenerationRequest, RunQueryRequest, RunQueryResponse, LikeQueryRequest, LikeQueryResponse, DescribeQueryRequest, DescribeQueryResponse, CancelQueryRequest, CancelQueryResponse, Tweak, AutoCompleteRequest, AutoCompleteResponse, DiffQueryRequest, DiffQueryResponse, QueryPerformanceRequest, QueryPerformanceResponse, GenerateQuestionRequest, GeneratedQuestion, GenerateQuestionResponse }; |
@@ -11,8 +11,3 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.Query = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
const GENERATE_ENDPOINT = 'generate-query'; | ||
@@ -30,42 +25,79 @@ const RUN_ENDPOINT = 'run-query'; | ||
const GENERATE_QUESTION_ENDPOINT = 'generate-questions'; | ||
exports.Query = (function () { | ||
return { | ||
generate: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GENERATE_ENDPOINT, params, signal); | ||
}), | ||
transcode: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(TRANSCODE_ENDPOINT, params, signal); | ||
}), | ||
run: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(RUN_ENDPOINT, params, signal); | ||
}), | ||
like: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(FAVORITE_ENDPOINT, params, signal); | ||
}), | ||
submit: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(SUBMIT_ENDPOINT, params, signal); | ||
}), | ||
getResults: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(RESULTS_ENDPOINT, params, signal); | ||
}), | ||
cancel: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(CANCEL_ENDPOINT, params, signal); | ||
}), | ||
describe: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(DESCRIBE_ENDPOINT, params, signal); | ||
}), | ||
autoComplete: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(AUTOCOMPLETE_ENDPOINT, params, signal); | ||
}), | ||
diff: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(DIFF_ENDPOINT, params, signal); | ||
}), | ||
analyzePerformance: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(PERF_ENDPOINT, params, signal); | ||
}), | ||
generateQuestion: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GENERATE_QUESTION_ENDPOINT, params, signal); | ||
}) | ||
}; | ||
})(); | ||
exports.default = exports.Query; | ||
class Query { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
; | ||
generate(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GENERATE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
transcode(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(TRANSCODE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
run(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(RUN_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
like(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(FAVORITE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
submit(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(SUBMIT_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
getResults(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(RESULTS_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
cancel(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(CANCEL_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
describe(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(DESCRIBE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
autoComplete(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(AUTOCOMPLETE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
diff(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(DIFF_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
analyzePerformance(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(PERF_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
generateQuestion(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GENERATE_QUESTION_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
} | ||
; | ||
exports.default = Query; |
@@ -0,1 +1,2 @@ | ||
import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
declare class SemanticStatement { | ||
@@ -32,7 +33,9 @@ id?: string; | ||
}; | ||
export declare let SemanticContext: { | ||
modifySemanticContext: (params: ModifySemanticContextRequest, signal?: AbortSignal) => Promise<ModifySemanticContextResponse>; | ||
getSemanticContext: (params?: GetSemanticContextRequest, signal?: AbortSignal) => Promise<GetSemanticContextResponse>; | ||
}; | ||
declare class SemanticContext { | ||
private httpClient; | ||
constructor(httpClient: WaiiHttpClient); | ||
modifySemanticContext(params: ModifySemanticContextRequest, signal?: AbortSignal): Promise<ModifySemanticContextResponse>; | ||
getSemanticContext(params?: GetSemanticContextRequest, signal?: AbortSignal): Promise<GetSemanticContextResponse>; | ||
} | ||
export default SemanticContext; | ||
export { SemanticStatement, ModifySemanticContextRequest, ModifySemanticContextResponse, GetSemanticContextRequestFilter, GetSemanticContextRequest, GetSemanticContextResponse }; |
@@ -11,8 +11,4 @@ "use strict"; | ||
}; | ||
var __importDefault = (this && this.__importDefault) || function (mod) { | ||
return (mod && mod.__esModule) ? mod : { "default": mod }; | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.SemanticStatement = exports.SemanticContext = void 0; | ||
const WaiiHttpClient_1 = __importDefault(require("../../../lib/src/WaiiHttpClient")); | ||
exports.SemanticStatement = void 0; | ||
const uuid_1 = require("uuid"); | ||
@@ -33,12 +29,18 @@ const MODIFY_ENDPOINT = 'update-semantic-context'; | ||
exports.SemanticStatement = SemanticStatement; | ||
exports.SemanticContext = (function () { | ||
return { | ||
modifySemanticContext: (params, signal) => __awaiter(this, void 0, void 0, function* () { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(MODIFY_ENDPOINT, params, signal); | ||
}), | ||
getSemanticContext: (params = {}, signal) => { | ||
return WaiiHttpClient_1.default.getInstance().commonFetch(GET_ENDPOINT, params, signal); | ||
}, | ||
}; | ||
})(); | ||
exports.default = exports.SemanticContext; | ||
class SemanticContext { | ||
constructor(httpClient) { | ||
this.httpClient = httpClient; | ||
} | ||
modifySemanticContext(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(MODIFY_ENDPOINT, params, signal); | ||
}); | ||
} | ||
; | ||
getSemanticContext(params = {}, signal) { | ||
return this.httpClient.commonFetch(GET_ENDPOINT, params, signal); | ||
} | ||
; | ||
} | ||
; | ||
exports.default = SemanticContext; |
@@ -1,3 +0,2 @@ | ||
export default class WaiiHttpClient { | ||
private static instance; | ||
declare class WaiiHttpClient { | ||
url: string; | ||
@@ -9,4 +8,3 @@ apiKey: string; | ||
userId: string; | ||
private constructor(); | ||
static getInstance(url?: string, apiKey?: string): WaiiHttpClient; | ||
constructor(url?: string, apiKey?: string); | ||
setScope(scope: string): void; | ||
@@ -18,1 +16,2 @@ getScope(): string; | ||
} | ||
export default WaiiHttpClient; |
@@ -13,3 +13,3 @@ "use strict"; | ||
class WaiiHttpClient { | ||
constructor(url, apiKey) { | ||
constructor(url = 'http://localhost:9859/api/', apiKey = '') { | ||
this.timeout = 150000000; | ||
@@ -22,20 +22,19 @@ this.scope = ''; | ||
} | ||
static getInstance(url = 'http://localhost:9859/api/', apiKey = '') { | ||
if (!WaiiHttpClient.instance) { | ||
WaiiHttpClient.instance = new WaiiHttpClient(url, apiKey); | ||
} | ||
return WaiiHttpClient.instance; | ||
} | ||
; | ||
setScope(scope) { | ||
this.scope = scope; | ||
} | ||
; | ||
getScope() { | ||
return this.scope; | ||
} | ||
; | ||
setOrgId(orgId) { | ||
this.orgId = orgId; | ||
} | ||
; | ||
setUserId(userId) { | ||
this.userId = userId; | ||
} | ||
; | ||
commonFetch(endpoint, params, signal) { | ||
@@ -83,3 +82,5 @@ return __awaiter(this, void 0, void 0, function* () { | ||
} | ||
; | ||
} | ||
; | ||
exports.default = WaiiHttpClient; |
@@ -24,3 +24,3 @@ "use strict"; | ||
updated: [{ | ||
key: '', // will be generated by the system | ||
key: '', | ||
account_name: '<your account name>', | ||
@@ -27,0 +27,0 @@ database: '<your database>', |
@@ -1,55 +0,23 @@ | ||
export declare let WAII: { | ||
History: { | ||
list: (params?: import("../clients/history/src/History").GetGeneratedQueryHistoryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/history/src/History").GetGeneratedQueryHistoryResponse>; | ||
}; | ||
SemanticContext: { | ||
modifySemanticContext: (params: import("../clients/semantic-context/src/SemanticContext").ModifySemanticContextRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/semantic-context/src/SemanticContext").ModifySemanticContextResponse>; | ||
getSemanticContext: (params?: import("../clients/semantic-context/src/SemanticContext").GetSemanticContextRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/semantic-context/src/SemanticContext").GetSemanticContextResponse>; | ||
}; | ||
Query: { | ||
generate: (params: import("../clients/query/src/Query").QueryGenerationRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").GeneratedQuery>; | ||
transcode: (params: { | ||
search_context?: import("../clients/database/src/Database").SearchContext[] | undefined; | ||
ask?: string | undefined; | ||
source_dialect: string; | ||
source_query: string; | ||
target_dialect: string; | ||
}, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").GeneratedQuery>; | ||
run: (params: import("../clients/query/src/Query").RunQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").GetQueryResultResponse>; | ||
like: (params: import("../clients/query/src/Query").LikeQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").LikeQueryResponse>; | ||
submit: (params: import("../clients/query/src/Query").RunQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").RunQueryResponse>; | ||
getResults: (params: import("../clients/query/src/Query").GetQueryResultRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").GetQueryResultResponse>; | ||
cancel: (params: import("../clients/query/src/Query").CancelQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").CancelQueryResponse>; | ||
describe: (params: import("../clients/query/src/Query").DescribeQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").DescribeQueryResponse>; | ||
autoComplete: (params: import("../clients/query/src/Query").AutoCompleteRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").AutoCompleteResponse>; | ||
diff: (params: import("../clients/query/src/Query").DiffQueryRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").DiffQueryResponse>; | ||
analyzePerformance: (params: import("../clients/query/src/Query").QueryPerformanceRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").QueryPerformanceResponse>; | ||
generateQuestion: (params: import("../clients/query/src/Query").GenerateQuestionRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/query/src/Query").GenerateQuestionResponse>; | ||
}; | ||
Database: { | ||
modifyConnections: (params: import("../clients/database/src/Database").ModifyDBConnectionRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").ModifyDBConnectionResponse>; | ||
getConnections: (params?: import("../clients/database/src/Database").GetDBConnectionRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").GetDBConnectionResponse>; | ||
activateConnection: (key: string, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").GetDBConnectionResponse>; | ||
getCatalogs: (params?: import("../clients/database/src/Database").GetCatalogRequest, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").GetCatalogResponse>; | ||
getDefaultConnection: () => string; | ||
updateTableDescription: (params: { | ||
table_name: import("../clients/database/src/Database").TableName; | ||
description: string; | ||
}, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").ModifyDBConnectionResponse>; | ||
updateSchemaDescription: (params: { | ||
schema_name: import("../clients/database/src/Database").SchemaName; | ||
description: import("../clients/database/src/Database").SchemaDescription; | ||
}, signal?: AbortSignal | undefined) => Promise<import("../clients/database/src/Database").ModifyDBConnectionResponse>; | ||
}; | ||
AccessKey: { | ||
getKeys: () => Promise<import("../clients/AccessKey/src/AccessKey").KeysList>; | ||
}; | ||
HealthCheck: { | ||
healthCheck: () => Promise<any>; | ||
}; | ||
initialize: (url?: string, apiKey?: string) => void; | ||
Authorization: { | ||
authorize: (params: import("../clients/authorization/src/Authorization").AuthRequest, signal?: AbortSignal | undefined) => Promise<{}>; | ||
}; | ||
}; | ||
import History from "../clients/history/src/History"; | ||
import Query from "../clients/query/src/Query"; | ||
import Database from "../clients/database/src/Database"; | ||
import SemanticContext from "../clients/semantic-context/src/SemanticContext"; | ||
import AccessKey from "../clients/AccessKey/src/AccessKey"; | ||
import HealthCheck from "../clients/health/src/HealthCheck"; | ||
import WaiiHttpClient from "../lib/src/WaiiHttpClient"; | ||
import Authorization from "../clients/authorization/src/Authorization"; | ||
declare class Waii { | ||
HttpClient: WaiiHttpClient; | ||
History: History; | ||
SemanticContext: SemanticContext; | ||
Query: Query; | ||
Database: Database; | ||
AccessKey: AccessKey; | ||
HealthCheck: HealthCheck; | ||
Authorization: Authorization; | ||
constructor(url?: string, apiKey?: string); | ||
initialize(url?: string, apiKey?: string): void; | ||
} | ||
declare const WAII: Waii; | ||
export default WAII; | ||
export { Waii }; |
@@ -6,3 +6,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.WAII = void 0; | ||
exports.Waii = void 0; | ||
const History_1 = __importDefault(require("../clients/history/src/History")); | ||
@@ -16,16 +16,20 @@ const Query_1 = __importDefault(require("../clients/query/src/Query")); | ||
const Authorization_1 = __importDefault(require("../clients/authorization/src/Authorization")); | ||
exports.WAII = (function () { | ||
return { | ||
History: History_1.default, | ||
SemanticContext: SemanticContext_1.default, | ||
Query: Query_1.default, | ||
Database: Database_1.default, | ||
AccessKey: AccessKey_1.default, | ||
HealthCheck: HealthCheck_1.default, | ||
initialize: (url = 'http://localhost:9859/api/', apiKey = '') => { | ||
WaiiHttpClient_1.default.getInstance(url, apiKey); | ||
}, | ||
Authorization: Authorization_1.default | ||
}; | ||
})(); | ||
exports.default = exports.WAII; | ||
class Waii { | ||
constructor(url = 'http://localhost:9859/api/', apiKey = '') { | ||
this.initialize(url, apiKey); | ||
} | ||
initialize(url = 'http://localhost:9859/api/', apiKey = '') { | ||
this.HttpClient = new WaiiHttpClient_1.default(url, apiKey); | ||
this.History = new History_1.default(this.HttpClient); | ||
this.SemanticContext = new SemanticContext_1.default(this.HttpClient); | ||
this.Query = new Query_1.default(this.HttpClient); | ||
this.Database = new Database_1.default(this.HttpClient); | ||
this.AccessKey = new AccessKey_1.default(this.HttpClient); | ||
this.HealthCheck = new HealthCheck_1.default(this.HttpClient); | ||
this.Authorization = new Authorization_1.default(this.HttpClient); | ||
} | ||
; | ||
} | ||
exports.Waii = Waii; | ||
const WAII = new Waii(); | ||
exports.default = WAII; |
{ | ||
"name": "waii-sdk-js", | ||
"version": "1.10.2", | ||
"version": "1.11.0", | ||
"description": "Typescript / Javascript SDK for the waii api. SQL generation and much more.", | ||
@@ -5,0 +5,0 @@ "main": "dist/src/waii-sdk.js", |
@@ -19,2 +19,3 @@ # WAII SDK Documentation for TypeScript and JavaScript | ||
- [Analyzing the performance of a query](#performance-query) | ||
- [Generate questions from database schema](#generate-questions) | ||
3. [Semantic Context Module](#semantic-context-module) | ||
@@ -155,2 +156,10 @@ - [Modifying the Semantic Context](#modifying-the-semantic-context) | ||
- `confidence_score` (optional): returns logprob confidence score based on the tokens from generated queries. | ||
- `llm_usage_stats`: token consumption during the query generation. | ||
- `token_total`: total token usage (prompt + completed), this doesn't include cached tokens. So if you see the total_total = 0, the query is fetched from the cache. | ||
- `elapsed_time_ms`: total elapsed time (in milli-seconds) between RPC request/response. | ||
Please note that some fields in the `GeneratedQuery` object may be optional, and their presence depends on the details of the specific generated query. | ||
@@ -418,2 +427,32 @@ | ||
### Generate questions from database schema | ||
This function allows you to generate questions from the database schema. | ||
```typescript | ||
async function generateQuestion(params: GenerateQuestionRequest, signal?: AbortSignal): Promise<GenerateQuestionResponse>; | ||
``` | ||
#### Parameters | ||
- `schema_name` (required): The name of the schema to generate questions from. | ||
- `n_questions` (optional): The number of questions to generate. Default is 10 | ||
- `complexity` (optional): The complexity of the questions to generate. Default is "medium". Possible values are "easy", "medium", "hard". | ||
#### Returns | ||
- A list of questions generated from the schema. | ||
- Each question (`GeneratedQuestion`) contains the question text, the complexity of the question, and the tables involved in the question. | ||
#### Example | ||
```typescript | ||
WAII.Query.generateQuestion({ | ||
schema_name: <schema_name like My_Schema>, | ||
n_questions: <n_questions>, | ||
complexity: "hard" | ||
}).then((result) => { | ||
for (let i = 0; !(result.questions) || i < result.questions.length; i++) { | ||
// ... | ||
} | ||
}) | ||
``` | ||
## Semantic Context Module <a name="semantic-context-module"></a> | ||
@@ -420,0 +459,0 @@ |
1394
782
3
118455
35