waii-sdk-js
Advanced tools
Comparing version 1.23.2 to 1.24.0
@@ -11,2 +11,5 @@ import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
chart_type?: ChartType; | ||
parameters?: { | ||
[param: string]: any; | ||
}; | ||
}; | ||
@@ -13,0 +16,0 @@ type ChatResponse = { |
@@ -101,2 +101,6 @@ import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
}; | ||
type ColumnName = { | ||
table_name: TableName; | ||
column_name: string; | ||
}; | ||
type TableReference = { | ||
@@ -132,2 +136,3 @@ src_table?: TableName[]; | ||
sample_values?: ColumnSampleValues[]; | ||
similarity_search_index_id?: string; | ||
}; | ||
@@ -200,2 +205,61 @@ type Catalog = { | ||
}; | ||
type CheckOperationStatusRequest = { | ||
op_id: string; | ||
}; | ||
declare enum OperationStatus { | ||
SUCCEEDED = "succeeded", | ||
FAILED = "failed", | ||
IN_PROGRESS = "in_progress", | ||
NOT_EXISTS = "not_exists" | ||
} | ||
type CheckOperationStatusResponse = { | ||
op_id: string; | ||
status: OperationStatus; | ||
info?: string; | ||
}; | ||
type ColumnValue = { | ||
value: string; | ||
additional_info?: string[]; | ||
}; | ||
type UpdateSimilaritySearchIndexRequest = { | ||
values?: ColumnValue[]; | ||
column: ColumnName; | ||
enable_llm_rerank?: boolean; | ||
similarity_score_threshold?: number; | ||
max_matched_values?: number; | ||
min_matched_values?: number; | ||
}; | ||
type UpdateSimilaritySearchIndexResponse = { | ||
op_id: string; | ||
}; | ||
type DeleteSimilaritySearchIndexRequest = { | ||
column: ColumnName; | ||
}; | ||
type DeleteSimilaritySearchIndexResponse = { | ||
op_id?: string; | ||
}; | ||
type SimilaritySearchIndexProperties = { | ||
enable_llm_rerank?: boolean; | ||
similarity_score_threshold?: number; | ||
max_matched_values?: number; | ||
min_matched_values?: number; | ||
column?: ColumnName; | ||
index_id?: string; | ||
}; | ||
type GetSimilaritySearchIndexRequest = { | ||
column: ColumnName; | ||
}; | ||
type GetSimilaritySearchIndexOnTableResponse = { | ||
table: TableName; | ||
columns: ColumnName[]; | ||
search_index_properties: SimilaritySearchIndexProperties[]; | ||
}; | ||
type GetSimilaritySearchIndexResponse = { | ||
column: ColumnName; | ||
values?: ColumnValue[]; | ||
properties?: SimilaritySearchIndexProperties; | ||
}; | ||
type GetSimilaritySearchIndexOnTableRequest = { | ||
table: TableName; | ||
}; | ||
declare class Database { | ||
@@ -213,4 +277,9 @@ private httpClient; | ||
extractDatabaseDocumentation(params: ExtractDatabaseDocumentationRequest, signal?: AbortSignal): Promise<ExtractDatabaseDocumentationResponse>; | ||
checkSimilaritySearchIndexStatus(params: CheckOperationStatusRequest, signal?: AbortSignal): Promise<CheckOperationStatusResponse>; | ||
updateSimilaritySearchIndex(params: UpdateSimilaritySearchIndexRequest, signal?: AbortSignal): Promise<UpdateSimilaritySearchIndexResponse>; | ||
getSimilaritySearchIndex(params: GetSimilaritySearchIndexRequest, signal?: AbortSignal): Promise<GetSimilaritySearchIndexResponse>; | ||
getSimilaritySearchIndexOnTable(params: GetSimilaritySearchIndexOnTableRequest, signal?: AbortSignal): Promise<GetSimilaritySearchIndexOnTableResponse>; | ||
deleteSimilaritySearchIndex(params: DeleteSimilaritySearchIndexRequest, signal?: AbortSignal): Promise<DeleteSimilaritySearchIndexResponse>; | ||
} | ||
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, DBContentFilterActionType, ColumnDocumentation, TableDocumentation, SchemaDocumentation, DatabaseDocumentation, ExtractDatabaseDocumentationRequest, ExtractDatabaseDocumentationResponse, DocumentContentType }; | ||
export { DBConnection, Catalog, Schema, Table, SchemaName, TableName, ColumnName, TableDescriptionPair, TableReference, SchemaDescription, SearchContext, Column, ColumnSampleValues, GetDBConnectionRequest, GetDBConnectionResponse, ModifyDBConnectionRequest, ModifyDBConnectionResponse, GetCatalogRequest, GetCatalogResponse, DBConnectionIndexingStatus, SchemaIndexingStatus, DBContentFilter, DBContentFilterScope, DBContentFilterType, DBContentFilterActionType, ColumnDocumentation, TableDocumentation, SchemaDocumentation, DatabaseDocumentation, ExtractDatabaseDocumentationRequest, ExtractDatabaseDocumentationResponse, DocumentContentType, CheckOperationStatusRequest, CheckOperationStatusResponse, UpdateSimilaritySearchIndexRequest, UpdateSimilaritySearchIndexResponse, GetSimilaritySearchIndexRequest, GetSimilaritySearchIndexResponse, GetSimilaritySearchIndexOnTableRequest, GetSimilaritySearchIndexOnTableResponse, DeleteSimilaritySearchIndexRequest, DeleteSimilaritySearchIndexResponse }; |
@@ -19,2 +19,7 @@ "use strict"; | ||
const EXTRACT_DATABASE_DOCUMENTATION_ENDPOINT = 'extract-database-documentation'; | ||
const UPDATE_SIMILARITY_SEARCH_INDEX_ENDPOINT = 'update-similarity-search-index'; | ||
const GET_SIMILARITY_SEARCH_INDEX_ENDPOINT = 'get-similarity-search-index'; | ||
const DELETE_SIMILARITY_SEARCH_INDEX_ENDPOINT = 'delete-similarity-search-index'; | ||
const CHECK_SIMILARITY_SEARCH_INDEX_STATUS_ENDPOINT = 'check-similarity-search-index-status'; | ||
const GET_SIMILARITY_SEARCH_INDEX_TABLE_ENDPOINT = 'get-similarity-search-index-table'; | ||
var DBContentFilterScope; | ||
@@ -44,2 +49,9 @@ (function (DBContentFilterScope) { | ||
})(DocumentContentType || (exports.DocumentContentType = DocumentContentType = {})); | ||
var OperationStatus; | ||
(function (OperationStatus) { | ||
OperationStatus["SUCCEEDED"] = "succeeded"; | ||
OperationStatus["FAILED"] = "failed"; | ||
OperationStatus["IN_PROGRESS"] = "in_progress"; | ||
OperationStatus["NOT_EXISTS"] = "not_exists"; | ||
})(OperationStatus || (OperationStatus = {})); | ||
class Database { | ||
@@ -54,4 +66,4 @@ constructor(httpClient) { | ||
} | ||
getConnections(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
getConnections() { | ||
return __awaiter(this, arguments, void 0, function* (params = {}, signal) { | ||
return this.httpClient.commonFetch(MODIFY_DB_ENDPOINT, params, signal); | ||
@@ -71,4 +83,4 @@ }); | ||
; | ||
getCatalogs(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
getCatalogs() { | ||
return __awaiter(this, arguments, void 0, function* (params = {}, signal) { | ||
return this.httpClient.commonFetch(GET_CATALOG_ENDPOINT, params, signal); | ||
@@ -103,4 +115,29 @@ }); | ||
} | ||
checkSimilaritySearchIndexStatus(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(CHECK_SIMILARITY_SEARCH_INDEX_STATUS_ENDPOINT, params, signal); | ||
}); | ||
} | ||
updateSimilaritySearchIndex(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(UPDATE_SIMILARITY_SEARCH_INDEX_ENDPOINT, params, signal); | ||
}); | ||
} | ||
getSimilaritySearchIndex(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GET_SIMILARITY_SEARCH_INDEX_ENDPOINT, params, signal); | ||
}); | ||
} | ||
getSimilaritySearchIndexOnTable(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(GET_SIMILARITY_SEARCH_INDEX_TABLE_ENDPOINT, params, signal); | ||
}); | ||
} | ||
deleteSimilaritySearchIndex(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(DELETE_SIMILARITY_SEARCH_INDEX_ENDPOINT, params, signal); | ||
}); | ||
} | ||
} | ||
; | ||
exports.default = Database; |
@@ -19,4 +19,4 @@ "use strict"; | ||
; | ||
list(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
list() { | ||
return __awaiter(this, arguments, void 0, function* (params = {}, signal) { | ||
return this.httpClient.commonFetch(LIST_ENDPOINT, params, signal); | ||
@@ -26,4 +26,4 @@ }); | ||
; | ||
get(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
get() { | ||
return __awaiter(this, arguments, void 0, function* (params = {}, signal) { | ||
const response = yield this.httpClient.commonFetch(GET_ENDPOINT, params, signal); | ||
@@ -30,0 +30,0 @@ let _history = []; |
@@ -184,2 +184,26 @@ import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
}; | ||
declare enum ExpandQueryState { | ||
SUCCEEDED = "succeeded", | ||
FAILED = "failed" | ||
} | ||
type PopulateSimilaritySearchFunctionsStatus = { | ||
query: string; | ||
state: ExpandQueryState; | ||
msg?: string; | ||
}; | ||
declare enum ExpandQueryOperations { | ||
TABLE_ACCESS_RULES = "table_access_rules", | ||
VIRTUAL_UDTFS = "virtual_udtfs", | ||
ALL = "all" | ||
} | ||
type ExpandQueryRequest = { | ||
query: string; | ||
operations: ExpandQueryOperations[]; | ||
dialect?: string; | ||
}; | ||
type ExpandQueryResponse = { | ||
query: string; | ||
access_rule_protection_status?: AccessRuleProtectionStatus; | ||
populate_similarity_search_function_status?: PopulateSimilaritySearchFunctionsStatus; | ||
}; | ||
declare class Query { | ||
@@ -203,4 +227,5 @@ private httpClient; | ||
getSimilarQuery(params: GenerateQuestionRequest, signal?: AbortSignal): Promise<SimilarQueryResponse>; | ||
expandQuery(params: ExpandQueryRequest, signal?: AbortSignal): Promise<ExpandQueryResponse>; | ||
} | ||
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, SimilarQueryResponse, ApplyTableAccessRulesResponse, AccessRuleProtectionStatus, ApplyTableAccessRulesRequest, AccessRuleProtectionState }; |
@@ -28,2 +28,3 @@ "use strict"; | ||
const TABLE_ACCESS_RULES_ENDPOINT = 'apply-table-access-rules'; | ||
const EXPAND_QUERY_ENDPOINT = 'expand-query'; | ||
// This is supported target persona for describe query | ||
@@ -37,2 +38,13 @@ const TARGET_PERSONA_SQL_EXPERT = 'sql_expert'; | ||
})(AccessRuleProtectionState || (exports.AccessRuleProtectionState = AccessRuleProtectionState = {})); | ||
var ExpandQueryState; | ||
(function (ExpandQueryState) { | ||
ExpandQueryState["SUCCEEDED"] = "succeeded"; | ||
ExpandQueryState["FAILED"] = "failed"; | ||
})(ExpandQueryState || (ExpandQueryState = {})); | ||
var ExpandQueryOperations; | ||
(function (ExpandQueryOperations) { | ||
ExpandQueryOperations["TABLE_ACCESS_RULES"] = "table_access_rules"; | ||
ExpandQueryOperations["VIRTUAL_UDTFS"] = "virtual_udtfs"; | ||
ExpandQueryOperations["ALL"] = "all"; | ||
})(ExpandQueryOperations || (ExpandQueryOperations = {})); | ||
class Query { | ||
@@ -129,4 +141,9 @@ constructor(httpClient) { | ||
} | ||
expandQuery(params, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.httpClient.commonFetch(EXPAND_QUERY_ENDPOINT, params, signal); | ||
}); | ||
} | ||
} | ||
; | ||
exports.default = Query; |
@@ -25,6 +25,2 @@ import WaiiHttpClient from "../../../lib/src/WaiiHttpClient"; | ||
possible_values?: any[]; | ||
org_id?: string; | ||
tenant_id?: string; | ||
user_id?: string; | ||
connection_key?: string; | ||
}; | ||
@@ -31,0 +27,0 @@ type ListParametersResponse = { |
@@ -39,4 +39,4 @@ "use strict"; | ||
; | ||
listParameters(params = {}, signal) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
listParameters() { | ||
return __awaiter(this, arguments, void 0, function* (params = {}, signal) { | ||
return this.httpClient.commonFetch(LIST_PARAMETERS_ENDPOINT, params, signal); | ||
@@ -43,0 +43,0 @@ }); |
@@ -24,3 +24,3 @@ "use strict"; | ||
updated: [{ | ||
key: '', | ||
key: '', // will be generated by the system | ||
account_name: '<your account name>', | ||
@@ -27,0 +27,0 @@ database: '<your database>', |
{ | ||
"name": "waii-sdk-js", | ||
"version": "1.23.2", | ||
"version": "1.24.0", | ||
"description": "Typescript / Javascript SDK for the waii api. SQL generation and much more.", | ||
@@ -5,0 +5,0 @@ "main": "dist/src/waii-sdk.js", |
114140
2360