@gooddata/api-client-tiger 11.62.0-alpha.1 → 11.62.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +759 -236
- package/esm/client.d.ts +0 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +0 -3
- package/esm/endpoints/actions/index.d.ts +1 -1
- package/esm/endpoints/actions/index.d.ts.map +1 -1
- package/esm/endpoints/actions/index.js +3 -1
- package/esm/generated/afm-rest-api/api.d.ts +1056 -8
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +894 -6
- package/esm/generated/afm-rest-api/common.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +176 -88
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +103 -38
- package/esm/generated/ai-json-api/common.d.ts.map +1 -1
- package/esm/generated/automation-json-api/common.d.ts.map +1 -1
- package/esm/generated/export-json-api/common.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +11 -11
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/common.d.ts.map +1 -1
- package/esm/generated/result-json-api/common.d.ts.map +1 -1
- package/esm/generated/scan-json-api/common.d.ts.map +1 -1
- package/esm/index.d.ts +3 -6
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +0 -2
- package/package.json +7 -8
- package/esm/authActions.d.ts +0 -4
- package/esm/authActions.d.ts.map +0 -1
- package/esm/authActions.js +0 -3
- package/esm/endpoints/authActions/index.d.ts +0 -2
- package/esm/endpoints/authActions/index.d.ts.map +0 -1
- package/esm/endpoints/authActions/index.js +0 -4
- package/esm/generated/auth-json-api/api.d.ts +0 -898
- package/esm/generated/auth-json-api/api.d.ts.map +0 -1
- package/esm/generated/auth-json-api/api.js +0 -934
- package/esm/generated/auth-json-api/base.d.ts +0 -43
- package/esm/generated/auth-json-api/base.d.ts.map +0 -1
- package/esm/generated/auth-json-api/base.js +0 -32
- package/esm/generated/auth-json-api/common.d.ts +0 -66
- package/esm/generated/auth-json-api/common.d.ts.map +0 -1
- package/esm/generated/auth-json-api/common.js +0 -121
- package/esm/generated/auth-json-api/configuration.d.ts +0 -75
- package/esm/generated/auth-json-api/configuration.d.ts.map +0 -1
- package/esm/generated/auth-json-api/configuration.js +0 -71
- package/esm/generated/auth-json-api/index.d.ts +0 -14
- package/esm/generated/auth-json-api/index.d.ts.map +0 -1
- package/esm/generated/auth-json-api/index.js +0 -15
- package/esm/generated/auth-json-api/template.d.ts +0 -102
- package/esm/generated/auth-json-api/template.d.ts.map +0 -1
- package/esm/generated/auth-json-api/template.js +0 -151
|
@@ -133,6 +133,18 @@ export interface AfmExecution {
|
|
|
133
133
|
export interface AfmExecutionResponse {
|
|
134
134
|
'executionResponse': ExecutionResponse;
|
|
135
135
|
}
|
|
136
|
+
/**
|
|
137
|
+
* Computes an AFM as /afm/execute does, and reads its rows as a table. It has a column for each attribute and each measure of the AFM, named by its local identifier, the attributes first. Each attribute must use a label of its own.
|
|
138
|
+
*/
|
|
139
|
+
export interface AfmFlowInput {
|
|
140
|
+
'execution': AFM;
|
|
141
|
+
'settings'?: ExecutionSettings;
|
|
142
|
+
/**
|
|
143
|
+
* Type of the input.
|
|
144
|
+
*/
|
|
145
|
+
'type': AfmFlowInputTypeEnum;
|
|
146
|
+
}
|
|
147
|
+
export type AfmFlowInputTypeEnum = 'afm';
|
|
136
148
|
/**
|
|
137
149
|
* @type AfmIdentifier
|
|
138
150
|
* Reference to the attribute label to which the filter should be applied.
|
|
@@ -1003,6 +1015,24 @@ export interface FeedbackRequestDto {
|
|
|
1003
1015
|
'sentiment': FeedbackRequestDtoSentimentEnum;
|
|
1004
1016
|
}
|
|
1005
1017
|
export type FeedbackRequestDtoSentimentEnum = 'POSITIVE' | 'NEGATIVE';
|
|
1018
|
+
/**
|
|
1019
|
+
* Reads the latest version of a table uploaded to a GDSTORAGE data source.
|
|
1020
|
+
*/
|
|
1021
|
+
export interface FileFlowInput {
|
|
1022
|
+
/**
|
|
1023
|
+
* Identifier of the GDSTORAGE data source.
|
|
1024
|
+
*/
|
|
1025
|
+
'dataSourceId': string;
|
|
1026
|
+
/**
|
|
1027
|
+
* Name of the table in the data source.
|
|
1028
|
+
*/
|
|
1029
|
+
'table': string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Type of the input.
|
|
1032
|
+
*/
|
|
1033
|
+
'type': FileFlowInputTypeEnum;
|
|
1034
|
+
}
|
|
1035
|
+
export type FileFlowInputTypeEnum = 'file';
|
|
1006
1036
|
/**
|
|
1007
1037
|
* Specifies what is used for filtering.
|
|
1008
1038
|
*/
|
|
@@ -1023,6 +1053,197 @@ export type FilterDefinition = AbsoluteDateFilter | AbsoluteGranularityDateFilte
|
|
|
1023
1053
|
* Abstract filter definition type for simple metric.
|
|
1024
1054
|
*/
|
|
1025
1055
|
export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
|
|
1056
|
+
/**
|
|
1057
|
+
* A column of a flow result.
|
|
1058
|
+
*/
|
|
1059
|
+
export interface FlowColumn {
|
|
1060
|
+
/**
|
|
1061
|
+
* Metadata of the column, as the operation that produced it gives them.
|
|
1062
|
+
*/
|
|
1063
|
+
'metadata': {
|
|
1064
|
+
[key: string]: string;
|
|
1065
|
+
};
|
|
1066
|
+
/**
|
|
1067
|
+
* Name of the column.
|
|
1068
|
+
*/
|
|
1069
|
+
'name': string;
|
|
1070
|
+
/**
|
|
1071
|
+
* Type of the values in the column.
|
|
1072
|
+
*/
|
|
1073
|
+
'type': string;
|
|
1074
|
+
}
|
|
1075
|
+
/**
|
|
1076
|
+
* A submitted flow: where to read its result.
|
|
1077
|
+
*/
|
|
1078
|
+
export interface FlowExecutionResponse {
|
|
1079
|
+
'links': ExecutionLinks;
|
|
1080
|
+
}
|
|
1081
|
+
/**
|
|
1082
|
+
* @type FlowInput
|
|
1083
|
+
* An input of a flow.
|
|
1084
|
+
*/
|
|
1085
|
+
export type FlowInput = AfmFlowInput | FileFlowInput | SqlFlowInput;
|
|
1086
|
+
/**
|
|
1087
|
+
* An operation that a transformation can run.
|
|
1088
|
+
*/
|
|
1089
|
+
export interface FlowOperationDescriptor {
|
|
1090
|
+
/**
|
|
1091
|
+
* What the operation does.
|
|
1092
|
+
*/
|
|
1093
|
+
'description': string;
|
|
1094
|
+
/**
|
|
1095
|
+
* Inputs of the operation. The first one is the primary input, named data.
|
|
1096
|
+
*/
|
|
1097
|
+
'inputs': Array<FlowOperationInput>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Name of the operation. A transformation gives it as its operation.
|
|
1100
|
+
*/
|
|
1101
|
+
'name': string;
|
|
1102
|
+
'output': FlowOperationOutput;
|
|
1103
|
+
/**
|
|
1104
|
+
* JSON Schema of the parameters of the operation.
|
|
1105
|
+
*/
|
|
1106
|
+
'parameters': {
|
|
1107
|
+
[key: string]: any;
|
|
1108
|
+
};
|
|
1109
|
+
/**
|
|
1110
|
+
* True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused.
|
|
1111
|
+
*/
|
|
1112
|
+
'pure': boolean;
|
|
1113
|
+
}
|
|
1114
|
+
/**
|
|
1115
|
+
* An input of an operation.
|
|
1116
|
+
*/
|
|
1117
|
+
export interface FlowOperationInput {
|
|
1118
|
+
/**
|
|
1119
|
+
* What the operation expects in the input.
|
|
1120
|
+
*/
|
|
1121
|
+
'description': string;
|
|
1122
|
+
/**
|
|
1123
|
+
* Name of the input. A transformation binds it in its inputRefs.
|
|
1124
|
+
*/
|
|
1125
|
+
'name': string;
|
|
1126
|
+
}
|
|
1127
|
+
/**
|
|
1128
|
+
* The output of an operation.
|
|
1129
|
+
*/
|
|
1130
|
+
export interface FlowOperationOutput {
|
|
1131
|
+
/**
|
|
1132
|
+
* What the operation produces.
|
|
1133
|
+
*/
|
|
1134
|
+
'description': string;
|
|
1135
|
+
}
|
|
1136
|
+
/**
|
|
1137
|
+
* The operations that the transformations of a flow can run.
|
|
1138
|
+
*/
|
|
1139
|
+
export interface FlowOperations {
|
|
1140
|
+
/**
|
|
1141
|
+
* Available operations.
|
|
1142
|
+
*/
|
|
1143
|
+
'operations': Array<FlowOperationDescriptor>;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* A flow: named inputs and the transformations that run over them.
|
|
1147
|
+
*/
|
|
1148
|
+
export interface FlowRequest {
|
|
1149
|
+
/**
|
|
1150
|
+
* Inputs of the flow by name. A transformation refers to an input by its name.
|
|
1151
|
+
*/
|
|
1152
|
+
'inputs': {
|
|
1153
|
+
[key: string]: FlowInput;
|
|
1154
|
+
};
|
|
1155
|
+
/**
|
|
1156
|
+
* Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.
|
|
1157
|
+
*/
|
|
1158
|
+
'transformations'?: Array<FlowTransformation>;
|
|
1159
|
+
}
|
|
1160
|
+
/**
|
|
1161
|
+
* Description of a flow result.
|
|
1162
|
+
*/
|
|
1163
|
+
export interface FlowResultMetadata {
|
|
1164
|
+
/**
|
|
1165
|
+
* Columns of the result, in order.
|
|
1166
|
+
*/
|
|
1167
|
+
'columns': Array<FlowColumn>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Metadata of the result, as the operations that produced it give them.
|
|
1170
|
+
*/
|
|
1171
|
+
'metadata': {
|
|
1172
|
+
[key: string]: string;
|
|
1173
|
+
};
|
|
1174
|
+
/**
|
|
1175
|
+
* Number of rows in the result.
|
|
1176
|
+
*/
|
|
1177
|
+
'totalRows': number;
|
|
1178
|
+
}
|
|
1179
|
+
/**
|
|
1180
|
+
* Position of a page in a table result.
|
|
1181
|
+
*/
|
|
1182
|
+
export interface FlowTablePaging {
|
|
1183
|
+
/**
|
|
1184
|
+
* Maximum number of columns in the page.
|
|
1185
|
+
*/
|
|
1186
|
+
'columnLimit': number;
|
|
1187
|
+
/**
|
|
1188
|
+
* Index of the first column of the page.
|
|
1189
|
+
*/
|
|
1190
|
+
'columnOffset': number;
|
|
1191
|
+
/**
|
|
1192
|
+
* Maximum number of rows in the page.
|
|
1193
|
+
*/
|
|
1194
|
+
'rowLimit': number;
|
|
1195
|
+
/**
|
|
1196
|
+
* Index of the first row of the page.
|
|
1197
|
+
*/
|
|
1198
|
+
'rowOffset': number;
|
|
1199
|
+
/**
|
|
1200
|
+
* Number of columns in the result.
|
|
1201
|
+
*/
|
|
1202
|
+
'totalColumns': number;
|
|
1203
|
+
/**
|
|
1204
|
+
* Number of rows in the result.
|
|
1205
|
+
*/
|
|
1206
|
+
'totalRows': number;
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* A page of a table result.
|
|
1210
|
+
*/
|
|
1211
|
+
export interface FlowTableResult {
|
|
1212
|
+
/**
|
|
1213
|
+
* Columns of the page, in order.
|
|
1214
|
+
*/
|
|
1215
|
+
'columns': Array<FlowColumn>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Rows of the page. A row has one value for each column, in the order of the columns.
|
|
1218
|
+
*/
|
|
1219
|
+
'data': Array<Array<object>>;
|
|
1220
|
+
'paging': FlowTablePaging;
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* One transformation of a flow: an operation that runs over its inputs.
|
|
1224
|
+
*/
|
|
1225
|
+
export interface FlowTransformation {
|
|
1226
|
+
/**
|
|
1227
|
+
* Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result.
|
|
1228
|
+
*/
|
|
1229
|
+
'id'?: string | null;
|
|
1230
|
+
/**
|
|
1231
|
+
* Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation.
|
|
1232
|
+
*/
|
|
1233
|
+
'inputRefs'?: {
|
|
1234
|
+
[key: string]: string;
|
|
1235
|
+
};
|
|
1236
|
+
/**
|
|
1237
|
+
* Name of the operation, as the operation catalog lists it.
|
|
1238
|
+
*/
|
|
1239
|
+
'operation': string;
|
|
1240
|
+
/**
|
|
1241
|
+
* Parameters of the operation. They must match the parameter schema of the operation.
|
|
1242
|
+
*/
|
|
1243
|
+
'parameters'?: {
|
|
1244
|
+
[key: string]: any;
|
|
1245
|
+
};
|
|
1246
|
+
}
|
|
1026
1247
|
export interface ForecastRequest {
|
|
1027
1248
|
/**
|
|
1028
1249
|
* Confidence interval boundary value.
|
|
@@ -2172,6 +2393,24 @@ export interface SortKeyValueValue {
|
|
|
2172
2393
|
'direction'?: SortKeyValueValueDirectionEnum;
|
|
2173
2394
|
}
|
|
2174
2395
|
export type SortKeyValueValueDirectionEnum = 'ASC' | 'DESC';
|
|
2396
|
+
/**
|
|
2397
|
+
* Runs a SELECT statement on a data source and reads its rows as a table. Its columns are named and typed as the statement returns them. Data filters of the workspace and of the user do not apply. A GDSTORAGE, FlexConnect or platform-managed data source cannot run it.
|
|
2398
|
+
*/
|
|
2399
|
+
export interface SqlFlowInput {
|
|
2400
|
+
/**
|
|
2401
|
+
* Identifier of the data source that runs the statement.
|
|
2402
|
+
*/
|
|
2403
|
+
'dataSourceId': string;
|
|
2404
|
+
/**
|
|
2405
|
+
* One SELECT statement in the SQL dialect of the data source.
|
|
2406
|
+
*/
|
|
2407
|
+
'sql': string;
|
|
2408
|
+
/**
|
|
2409
|
+
* Type of the input.
|
|
2410
|
+
*/
|
|
2411
|
+
'type': SqlFlowInputTypeEnum;
|
|
2412
|
+
}
|
|
2413
|
+
export type SqlFlowInputTypeEnum = 'sql';
|
|
2175
2414
|
/**
|
|
2176
2415
|
* Operation that has succeeded
|
|
2177
2416
|
*/
|
|
@@ -4231,6 +4470,16 @@ export declare function ActionsApiAxiosParamCreator_AnomalyDetectionResult(works
|
|
|
4231
4470
|
* @throws {RequiredError}
|
|
4232
4471
|
*/
|
|
4233
4472
|
export declare function ActionsApiAxiosParamCreator_CancelExecutions(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4473
|
+
/**
|
|
4474
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
4475
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
4476
|
+
* @param {string} workspaceId Workspace identifier
|
|
4477
|
+
* @param {AfmCancelTokens} afmCancelTokens
|
|
4478
|
+
* @param {*} [options] Override http request option.
|
|
4479
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4480
|
+
* @throws {RequiredError}
|
|
4481
|
+
*/
|
|
4482
|
+
export declare function ActionsApiAxiosParamCreator_CancelFlows(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4234
4483
|
/**
|
|
4235
4484
|
*
|
|
4236
4485
|
* @param {string} workspaceId Workspace identifier
|
|
@@ -4350,6 +4599,16 @@ export declare function ActionsApiAxiosParamCreator_ComputeValidDescendants(work
|
|
|
4350
4599
|
* @throws {RequiredError}
|
|
4351
4600
|
*/
|
|
4352
4601
|
export declare function ActionsApiAxiosParamCreator_ComputeValidObjects(workspaceId: string, afmValidObjectsQuery: AfmValidObjectsQuery, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4602
|
+
/**
|
|
4603
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
4604
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
4605
|
+
* @param {string} workspaceId Workspace identifier
|
|
4606
|
+
* @param {FlowRequest} flowRequest
|
|
4607
|
+
* @param {*} [options] Override http request option.
|
|
4608
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4609
|
+
* @throws {RequiredError}
|
|
4610
|
+
*/
|
|
4611
|
+
export declare function ActionsApiAxiosParamCreator_ExecuteFlow(workspaceId: string, flowRequest: FlowRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4353
4612
|
/**
|
|
4354
4613
|
* The resource provides static structures needed for investigation of a problem with given AFM.
|
|
4355
4614
|
* @summary AFM explain resource.
|
|
@@ -4492,6 +4751,15 @@ export declare function ActionsApiAxiosParamCreator_KeyDriverAnalysis(workspaceI
|
|
|
4492
4751
|
* @throws {RequiredError}
|
|
4493
4752
|
*/
|
|
4494
4753
|
export declare function ActionsApiAxiosParamCreator_KeyDriverAnalysisResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4754
|
+
/**
|
|
4755
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
4756
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
4757
|
+
* @param {string} workspaceId Workspace identifier
|
|
4758
|
+
* @param {*} [options] Override http request option.
|
|
4759
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4760
|
+
* @throws {RequiredError}
|
|
4761
|
+
*/
|
|
4762
|
+
export declare function ActionsApiAxiosParamCreator_ListFlowOperations(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4495
4763
|
/**
|
|
4496
4764
|
* Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.
|
|
4497
4765
|
* @summary List LLM Provider Models
|
|
@@ -4561,6 +4829,44 @@ export declare function ActionsApiAxiosParamCreator_ResolveLlmEndpoints(workspac
|
|
|
4561
4829
|
* @throws {RequiredError}
|
|
4562
4830
|
*/
|
|
4563
4831
|
export declare function ActionsApiAxiosParamCreator_RetrieveExecutionMetadata(workspaceId: string, resultId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4832
|
+
/**
|
|
4833
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
4834
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
4835
|
+
* @param {string} workspaceId Workspace identifier
|
|
4836
|
+
* @param {string} resultId Result ID
|
|
4837
|
+
* @param {number} [rowOffset] Index of the first row to return. The default is 0.
|
|
4838
|
+
* @param {number} [rowLimit] Maximum number of rows to return. The default is all remaining rows.
|
|
4839
|
+
* @param {number} [columnOffset] Index of the first column to return. The default is 0.
|
|
4840
|
+
* @param {number} [columnLimit] Maximum number of columns to return. The default is all remaining columns.
|
|
4841
|
+
* @param {*} [options] Override http request option.
|
|
4842
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4843
|
+
* @throws {RequiredError}
|
|
4844
|
+
*/
|
|
4845
|
+
export declare function ActionsApiAxiosParamCreator_RetrieveFlowResultBinary(workspaceId: string, resultId: string, rowOffset?: number, rowLimit?: number, columnOffset?: number, columnLimit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4846
|
+
/**
|
|
4847
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
4848
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
4849
|
+
* @param {string} workspaceId Workspace identifier
|
|
4850
|
+
* @param {string} resultId Result ID
|
|
4851
|
+
* @param {*} [options] Override http request option.
|
|
4852
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4853
|
+
* @throws {RequiredError}
|
|
4854
|
+
*/
|
|
4855
|
+
export declare function ActionsApiAxiosParamCreator_RetrieveFlowResultMetadata(workspaceId: string, resultId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4856
|
+
/**
|
|
4857
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
4858
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
4859
|
+
* @param {string} workspaceId Workspace identifier
|
|
4860
|
+
* @param {string} resultId Result ID
|
|
4861
|
+
* @param {number} [rowOffset] Index of the first row to return. The default is 0.
|
|
4862
|
+
* @param {number} [rowLimit] Maximum number of rows to return. The default is all remaining rows.
|
|
4863
|
+
* @param {number} [columnOffset] Index of the first column to return. The default is 0.
|
|
4864
|
+
* @param {number} [columnLimit] Maximum number of columns to return. The default is all remaining columns.
|
|
4865
|
+
* @param {*} [options] Override http request option.
|
|
4866
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
4867
|
+
* @throws {RequiredError}
|
|
4868
|
+
*/
|
|
4869
|
+
export declare function ActionsApiAxiosParamCreator_RetrieveFlowResultTable(workspaceId: string, resultId: string, rowOffset?: number, rowLimit?: number, columnOffset?: number, columnLimit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4564
4870
|
/**
|
|
4565
4871
|
* Gets a single execution result.
|
|
4566
4872
|
* @summary Get a single execution result
|
|
@@ -4727,6 +5033,17 @@ export declare function ActionsApi_AnomalyDetectionResult(axios: AxiosInstance,
|
|
|
4727
5033
|
* @throws {RequiredError}
|
|
4728
5034
|
*/
|
|
4729
5035
|
export declare function ActionsApi_CancelExecutions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmCancelTokens>;
|
|
5036
|
+
/**
|
|
5037
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
5038
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
5039
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5040
|
+
* @param {string} basePath Base path.
|
|
5041
|
+
* @param {ActionsApiCancelFlowsRequest} requestParameters Request parameters.
|
|
5042
|
+
* @param {*} [options] Override http request option.
|
|
5043
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5044
|
+
* @throws {RequiredError}
|
|
5045
|
+
*/
|
|
5046
|
+
export declare function ActionsApi_CancelFlows(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmCancelTokens>;
|
|
4730
5047
|
/**
|
|
4731
5048
|
*
|
|
4732
5049
|
* @param {AxiosInstance} axios Axios instance.
|
|
@@ -4850,6 +5167,17 @@ export declare function ActionsApi_ComputeValidDescendants(axios: AxiosInstance,
|
|
|
4850
5167
|
* @throws {RequiredError}
|
|
4851
5168
|
*/
|
|
4852
5169
|
export declare function ActionsApi_ComputeValidObjects(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiComputeValidObjectsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmValidObjectsResponse>;
|
|
5170
|
+
/**
|
|
5171
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
5172
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
5173
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5174
|
+
* @param {string} basePath Base path.
|
|
5175
|
+
* @param {ActionsApiExecuteFlowRequest} requestParameters Request parameters.
|
|
5176
|
+
* @param {*} [options] Override http request option.
|
|
5177
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5178
|
+
* @throws {RequiredError}
|
|
5179
|
+
*/
|
|
5180
|
+
export declare function ActionsApi_ExecuteFlow(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiExecuteFlowRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowExecutionResponse>;
|
|
4853
5181
|
/**
|
|
4854
5182
|
* The resource provides static structures needed for investigation of a problem with given AFM.
|
|
4855
5183
|
* @summary AFM explain resource.
|
|
@@ -4999,6 +5327,17 @@ export declare function ActionsApi_KeyDriverAnalysis(axios: AxiosInstance, baseP
|
|
|
4999
5327
|
* @throws {RequiredError}
|
|
5000
5328
|
*/
|
|
5001
5329
|
export declare function ActionsApi_KeyDriverAnalysisResult(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<KeyDriversResult>;
|
|
5330
|
+
/**
|
|
5331
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
5332
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
5333
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5334
|
+
* @param {string} basePath Base path.
|
|
5335
|
+
* @param {ActionsApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
5336
|
+
* @param {*} [options] Override http request option.
|
|
5337
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5338
|
+
* @throws {RequiredError}
|
|
5339
|
+
*/
|
|
5340
|
+
export declare function ActionsApi_ListFlowOperations(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiListFlowOperationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowOperations>;
|
|
5002
5341
|
/**
|
|
5003
5342
|
* Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.
|
|
5004
5343
|
* @summary List LLM Provider Models
|
|
@@ -5076,6 +5415,39 @@ export declare function ActionsApi_ResolveLlmEndpoints(axios: AxiosInstance, bas
|
|
|
5076
5415
|
* @throws {RequiredError}
|
|
5077
5416
|
*/
|
|
5078
5417
|
export declare function ActionsApi_RetrieveExecutionMetadata(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiRetrieveExecutionMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ResultCacheMetadata>;
|
|
5418
|
+
/**
|
|
5419
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
5420
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
5421
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5422
|
+
* @param {string} basePath Base path.
|
|
5423
|
+
* @param {ActionsApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
5424
|
+
* @param {*} [options] Override http request option.
|
|
5425
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5426
|
+
* @throws {RequiredError}
|
|
5427
|
+
*/
|
|
5428
|
+
export declare function ActionsApi_RetrieveFlowResultBinary(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
|
|
5429
|
+
/**
|
|
5430
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
5431
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
5432
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5433
|
+
* @param {string} basePath Base path.
|
|
5434
|
+
* @param {ActionsApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
5435
|
+
* @param {*} [options] Override http request option.
|
|
5436
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5437
|
+
* @throws {RequiredError}
|
|
5438
|
+
*/
|
|
5439
|
+
export declare function ActionsApi_RetrieveFlowResultMetadata(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowResultMetadata>;
|
|
5440
|
+
/**
|
|
5441
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
5442
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
5443
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
5444
|
+
* @param {string} basePath Base path.
|
|
5445
|
+
* @param {ActionsApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
5446
|
+
* @param {*} [options] Override http request option.
|
|
5447
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
5448
|
+
* @throws {RequiredError}
|
|
5449
|
+
*/
|
|
5450
|
+
export declare function ActionsApi_RetrieveFlowResultTable(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowTableResult>;
|
|
5079
5451
|
/**
|
|
5080
5452
|
* Gets a single execution result.
|
|
5081
5453
|
* @summary Get a single execution result
|
|
@@ -5250,6 +5622,15 @@ export interface ActionsApiInterface {
|
|
|
5250
5622
|
* @memberof ActionsApiInterface
|
|
5251
5623
|
*/
|
|
5252
5624
|
cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
5625
|
+
/**
|
|
5626
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
5627
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
5628
|
+
* @param {ActionsApiCancelFlowsRequest} requestParameters Request parameters.
|
|
5629
|
+
* @param {*} [options] Override http request option.
|
|
5630
|
+
* @throws {RequiredError}
|
|
5631
|
+
* @memberof ActionsApiInterface
|
|
5632
|
+
*/
|
|
5633
|
+
cancelFlows(requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
5253
5634
|
/**
|
|
5254
5635
|
*
|
|
5255
5636
|
* @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
|
|
@@ -5351,6 +5732,15 @@ export interface ActionsApiInterface {
|
|
|
5351
5732
|
* @memberof ActionsApiInterface
|
|
5352
5733
|
*/
|
|
5353
5734
|
computeValidObjects(requestParameters: ActionsApiComputeValidObjectsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmValidObjectsResponse>;
|
|
5735
|
+
/**
|
|
5736
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
5737
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
5738
|
+
* @param {ActionsApiExecuteFlowRequest} requestParameters Request parameters.
|
|
5739
|
+
* @param {*} [options] Override http request option.
|
|
5740
|
+
* @throws {RequiredError}
|
|
5741
|
+
* @memberof ActionsApiInterface
|
|
5742
|
+
*/
|
|
5743
|
+
executeFlow(requestParameters: ActionsApiExecuteFlowRequest, options?: AxiosRequestConfig): AxiosPromise<FlowExecutionResponse>;
|
|
5354
5744
|
/**
|
|
5355
5745
|
* The resource provides static structures needed for investigation of a problem with given AFM.
|
|
5356
5746
|
* @summary AFM explain resource.
|
|
@@ -5472,6 +5862,15 @@ export interface ActionsApiInterface {
|
|
|
5472
5862
|
* @memberof ActionsApiInterface
|
|
5473
5863
|
*/
|
|
5474
5864
|
keyDriverAnalysisResult(requestParameters: ActionsApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<KeyDriversResult>;
|
|
5865
|
+
/**
|
|
5866
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
5867
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
5868
|
+
* @param {ActionsApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
5869
|
+
* @param {*} [options] Override http request option.
|
|
5870
|
+
* @throws {RequiredError}
|
|
5871
|
+
* @memberof ActionsApiInterface
|
|
5872
|
+
*/
|
|
5873
|
+
listFlowOperations(requestParameters: ActionsApiListFlowOperationsRequest, options?: AxiosRequestConfig): AxiosPromise<FlowOperations>;
|
|
5475
5874
|
/**
|
|
5476
5875
|
* Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.
|
|
5477
5876
|
* @summary List LLM Provider Models
|
|
@@ -5536,6 +5935,33 @@ export interface ActionsApiInterface {
|
|
|
5536
5935
|
* @memberof ActionsApiInterface
|
|
5537
5936
|
*/
|
|
5538
5937
|
retrieveExecutionMetadata(requestParameters: ActionsApiRetrieveExecutionMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<ResultCacheMetadata>;
|
|
5938
|
+
/**
|
|
5939
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
5940
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
5941
|
+
* @param {ActionsApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
5942
|
+
* @param {*} [options] Override http request option.
|
|
5943
|
+
* @throws {RequiredError}
|
|
5944
|
+
* @memberof ActionsApiInterface
|
|
5945
|
+
*/
|
|
5946
|
+
retrieveFlowResultBinary(requestParameters: ActionsApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
5947
|
+
/**
|
|
5948
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
5949
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
5950
|
+
* @param {ActionsApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
5951
|
+
* @param {*} [options] Override http request option.
|
|
5952
|
+
* @throws {RequiredError}
|
|
5953
|
+
* @memberof ActionsApiInterface
|
|
5954
|
+
*/
|
|
5955
|
+
retrieveFlowResultMetadata(requestParameters: ActionsApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<FlowResultMetadata>;
|
|
5956
|
+
/**
|
|
5957
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
5958
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
5959
|
+
* @param {ActionsApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
5960
|
+
* @param {*} [options] Override http request option.
|
|
5961
|
+
* @throws {RequiredError}
|
|
5962
|
+
* @memberof ActionsApiInterface
|
|
5963
|
+
*/
|
|
5964
|
+
retrieveFlowResultTable(requestParameters: ActionsApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig): AxiosPromise<FlowTableResult>;
|
|
5539
5965
|
/**
|
|
5540
5966
|
* Gets a single execution result.
|
|
5541
5967
|
* @summary Get a single execution result
|
|
@@ -5754,26 +6180,45 @@ export interface ActionsApiCancelExecutionsRequest {
|
|
|
5754
6180
|
readonly afmCancelTokens: AfmCancelTokens;
|
|
5755
6181
|
}
|
|
5756
6182
|
/**
|
|
5757
|
-
* Request parameters for
|
|
6183
|
+
* Request parameters for cancelFlows operation in ActionsApi.
|
|
5758
6184
|
* @export
|
|
5759
|
-
* @interface
|
|
6185
|
+
* @interface ActionsApiCancelFlowsRequest
|
|
5760
6186
|
*/
|
|
5761
|
-
export interface
|
|
6187
|
+
export interface ActionsApiCancelFlowsRequest {
|
|
5762
6188
|
/**
|
|
5763
6189
|
* Workspace identifier
|
|
5764
6190
|
* @type {string}
|
|
5765
|
-
* @memberof
|
|
6191
|
+
* @memberof ActionsApiCancelFlows
|
|
5766
6192
|
*/
|
|
5767
6193
|
readonly workspaceId: string;
|
|
5768
6194
|
/**
|
|
5769
6195
|
*
|
|
5770
|
-
* @type {
|
|
5771
|
-
* @memberof
|
|
6196
|
+
* @type {AfmCancelTokens}
|
|
6197
|
+
* @memberof ActionsApiCancelFlows
|
|
5772
6198
|
*/
|
|
5773
|
-
readonly
|
|
6199
|
+
readonly afmCancelTokens: AfmCancelTokens;
|
|
5774
6200
|
}
|
|
5775
6201
|
/**
|
|
5776
|
-
* Request parameters for
|
|
6202
|
+
* Request parameters for cancelWorkflow operation in ActionsApi.
|
|
6203
|
+
* @export
|
|
6204
|
+
* @interface ActionsApiCancelWorkflowRequest
|
|
6205
|
+
*/
|
|
6206
|
+
export interface ActionsApiCancelWorkflowRequest {
|
|
6207
|
+
/**
|
|
6208
|
+
* Workspace identifier
|
|
6209
|
+
* @type {string}
|
|
6210
|
+
* @memberof ActionsApiCancelWorkflow
|
|
6211
|
+
*/
|
|
6212
|
+
readonly workspaceId: string;
|
|
6213
|
+
/**
|
|
6214
|
+
*
|
|
6215
|
+
* @type {string}
|
|
6216
|
+
* @memberof ActionsApiCancelWorkflow
|
|
6217
|
+
*/
|
|
6218
|
+
readonly runId: string;
|
|
6219
|
+
}
|
|
6220
|
+
/**
|
|
6221
|
+
* Request parameters for cancelWorkflow1 operation in ActionsApi.
|
|
5777
6222
|
* @export
|
|
5778
6223
|
* @interface ActionsApiCancelWorkflow1Request
|
|
5779
6224
|
*/
|
|
@@ -6028,6 +6473,25 @@ export interface ActionsApiComputeValidObjectsRequest {
|
|
|
6028
6473
|
*/
|
|
6029
6474
|
readonly afmValidObjectsQuery: AfmValidObjectsQuery;
|
|
6030
6475
|
}
|
|
6476
|
+
/**
|
|
6477
|
+
* Request parameters for executeFlow operation in ActionsApi.
|
|
6478
|
+
* @export
|
|
6479
|
+
* @interface ActionsApiExecuteFlowRequest
|
|
6480
|
+
*/
|
|
6481
|
+
export interface ActionsApiExecuteFlowRequest {
|
|
6482
|
+
/**
|
|
6483
|
+
* Workspace identifier
|
|
6484
|
+
* @type {string}
|
|
6485
|
+
* @memberof ActionsApiExecuteFlow
|
|
6486
|
+
*/
|
|
6487
|
+
readonly workspaceId: string;
|
|
6488
|
+
/**
|
|
6489
|
+
*
|
|
6490
|
+
* @type {FlowRequest}
|
|
6491
|
+
* @memberof ActionsApiExecuteFlow
|
|
6492
|
+
*/
|
|
6493
|
+
readonly flowRequest: FlowRequest;
|
|
6494
|
+
}
|
|
6031
6495
|
/**
|
|
6032
6496
|
* Request parameters for explainAFM operation in ActionsApi.
|
|
6033
6497
|
* @export
|
|
@@ -6336,6 +6800,19 @@ export interface ActionsApiKeyDriverAnalysisResultRequest {
|
|
|
6336
6800
|
*/
|
|
6337
6801
|
readonly limit?: number;
|
|
6338
6802
|
}
|
|
6803
|
+
/**
|
|
6804
|
+
* Request parameters for listFlowOperations operation in ActionsApi.
|
|
6805
|
+
* @export
|
|
6806
|
+
* @interface ActionsApiListFlowOperationsRequest
|
|
6807
|
+
*/
|
|
6808
|
+
export interface ActionsApiListFlowOperationsRequest {
|
|
6809
|
+
/**
|
|
6810
|
+
* Workspace identifier
|
|
6811
|
+
* @type {string}
|
|
6812
|
+
* @memberof ActionsApiListFlowOperations
|
|
6813
|
+
*/
|
|
6814
|
+
readonly workspaceId: string;
|
|
6815
|
+
}
|
|
6339
6816
|
/**
|
|
6340
6817
|
* Request parameters for listLlmProviderModels operation in ActionsApi.
|
|
6341
6818
|
* @export
|
|
@@ -6463,6 +6940,111 @@ export interface ActionsApiRetrieveExecutionMetadataRequest {
|
|
|
6463
6940
|
*/
|
|
6464
6941
|
readonly resultId: string;
|
|
6465
6942
|
}
|
|
6943
|
+
/**
|
|
6944
|
+
* Request parameters for retrieveFlowResultBinary operation in ActionsApi.
|
|
6945
|
+
* @export
|
|
6946
|
+
* @interface ActionsApiRetrieveFlowResultBinaryRequest
|
|
6947
|
+
*/
|
|
6948
|
+
export interface ActionsApiRetrieveFlowResultBinaryRequest {
|
|
6949
|
+
/**
|
|
6950
|
+
* Workspace identifier
|
|
6951
|
+
* @type {string}
|
|
6952
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6953
|
+
*/
|
|
6954
|
+
readonly workspaceId: string;
|
|
6955
|
+
/**
|
|
6956
|
+
* Result ID
|
|
6957
|
+
* @type {string}
|
|
6958
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6959
|
+
*/
|
|
6960
|
+
readonly resultId: string;
|
|
6961
|
+
/**
|
|
6962
|
+
* Index of the first row to return. The default is 0.
|
|
6963
|
+
* @type {number}
|
|
6964
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6965
|
+
*/
|
|
6966
|
+
readonly rowOffset?: number;
|
|
6967
|
+
/**
|
|
6968
|
+
* Maximum number of rows to return. The default is all remaining rows.
|
|
6969
|
+
* @type {number}
|
|
6970
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6971
|
+
*/
|
|
6972
|
+
readonly rowLimit?: number;
|
|
6973
|
+
/**
|
|
6974
|
+
* Index of the first column to return. The default is 0.
|
|
6975
|
+
* @type {number}
|
|
6976
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6977
|
+
*/
|
|
6978
|
+
readonly columnOffset?: number;
|
|
6979
|
+
/**
|
|
6980
|
+
* Maximum number of columns to return. The default is all remaining columns.
|
|
6981
|
+
* @type {number}
|
|
6982
|
+
* @memberof ActionsApiRetrieveFlowResultBinary
|
|
6983
|
+
*/
|
|
6984
|
+
readonly columnLimit?: number;
|
|
6985
|
+
}
|
|
6986
|
+
/**
|
|
6987
|
+
* Request parameters for retrieveFlowResultMetadata operation in ActionsApi.
|
|
6988
|
+
* @export
|
|
6989
|
+
* @interface ActionsApiRetrieveFlowResultMetadataRequest
|
|
6990
|
+
*/
|
|
6991
|
+
export interface ActionsApiRetrieveFlowResultMetadataRequest {
|
|
6992
|
+
/**
|
|
6993
|
+
* Workspace identifier
|
|
6994
|
+
* @type {string}
|
|
6995
|
+
* @memberof ActionsApiRetrieveFlowResultMetadata
|
|
6996
|
+
*/
|
|
6997
|
+
readonly workspaceId: string;
|
|
6998
|
+
/**
|
|
6999
|
+
* Result ID
|
|
7000
|
+
* @type {string}
|
|
7001
|
+
* @memberof ActionsApiRetrieveFlowResultMetadata
|
|
7002
|
+
*/
|
|
7003
|
+
readonly resultId: string;
|
|
7004
|
+
}
|
|
7005
|
+
/**
|
|
7006
|
+
* Request parameters for retrieveFlowResultTable operation in ActionsApi.
|
|
7007
|
+
* @export
|
|
7008
|
+
* @interface ActionsApiRetrieveFlowResultTableRequest
|
|
7009
|
+
*/
|
|
7010
|
+
export interface ActionsApiRetrieveFlowResultTableRequest {
|
|
7011
|
+
/**
|
|
7012
|
+
* Workspace identifier
|
|
7013
|
+
* @type {string}
|
|
7014
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7015
|
+
*/
|
|
7016
|
+
readonly workspaceId: string;
|
|
7017
|
+
/**
|
|
7018
|
+
* Result ID
|
|
7019
|
+
* @type {string}
|
|
7020
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7021
|
+
*/
|
|
7022
|
+
readonly resultId: string;
|
|
7023
|
+
/**
|
|
7024
|
+
* Index of the first row to return. The default is 0.
|
|
7025
|
+
* @type {number}
|
|
7026
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7027
|
+
*/
|
|
7028
|
+
readonly rowOffset?: number;
|
|
7029
|
+
/**
|
|
7030
|
+
* Maximum number of rows to return. The default is all remaining rows.
|
|
7031
|
+
* @type {number}
|
|
7032
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7033
|
+
*/
|
|
7034
|
+
readonly rowLimit?: number;
|
|
7035
|
+
/**
|
|
7036
|
+
* Index of the first column to return. The default is 0.
|
|
7037
|
+
* @type {number}
|
|
7038
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7039
|
+
*/
|
|
7040
|
+
readonly columnOffset?: number;
|
|
7041
|
+
/**
|
|
7042
|
+
* Maximum number of columns to return. The default is all remaining columns.
|
|
7043
|
+
* @type {number}
|
|
7044
|
+
* @memberof ActionsApiRetrieveFlowResultTable
|
|
7045
|
+
*/
|
|
7046
|
+
readonly columnLimit?: number;
|
|
7047
|
+
}
|
|
6466
7048
|
/**
|
|
6467
7049
|
* Request parameters for retrieveResult operation in ActionsApi.
|
|
6468
7050
|
* @export
|
|
@@ -6703,6 +7285,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
6703
7285
|
* @memberof ActionsApi
|
|
6704
7286
|
*/
|
|
6705
7287
|
cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
7288
|
+
/**
|
|
7289
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
7290
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
7291
|
+
* @param {ActionsApiCancelFlowsRequest} requestParameters Request parameters.
|
|
7292
|
+
* @param {*} [options] Override http request option.
|
|
7293
|
+
* @throws {RequiredError}
|
|
7294
|
+
* @memberof ActionsApi
|
|
7295
|
+
*/
|
|
7296
|
+
cancelFlows(requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
6706
7297
|
/**
|
|
6707
7298
|
*
|
|
6708
7299
|
* @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
|
|
@@ -6804,6 +7395,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
6804
7395
|
* @memberof ActionsApi
|
|
6805
7396
|
*/
|
|
6806
7397
|
computeValidObjects(requestParameters: ActionsApiComputeValidObjectsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmValidObjectsResponse>;
|
|
7398
|
+
/**
|
|
7399
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
7400
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
7401
|
+
* @param {ActionsApiExecuteFlowRequest} requestParameters Request parameters.
|
|
7402
|
+
* @param {*} [options] Override http request option.
|
|
7403
|
+
* @throws {RequiredError}
|
|
7404
|
+
* @memberof ActionsApi
|
|
7405
|
+
*/
|
|
7406
|
+
executeFlow(requestParameters: ActionsApiExecuteFlowRequest, options?: AxiosRequestConfig): AxiosPromise<FlowExecutionResponse>;
|
|
6807
7407
|
/**
|
|
6808
7408
|
* The resource provides static structures needed for investigation of a problem with given AFM.
|
|
6809
7409
|
* @summary AFM explain resource.
|
|
@@ -6925,6 +7525,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
6925
7525
|
* @memberof ActionsApi
|
|
6926
7526
|
*/
|
|
6927
7527
|
keyDriverAnalysisResult(requestParameters: ActionsApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<KeyDriversResult>;
|
|
7528
|
+
/**
|
|
7529
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
7530
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
7531
|
+
* @param {ActionsApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
7532
|
+
* @param {*} [options] Override http request option.
|
|
7533
|
+
* @throws {RequiredError}
|
|
7534
|
+
* @memberof ActionsApi
|
|
7535
|
+
*/
|
|
7536
|
+
listFlowOperations(requestParameters: ActionsApiListFlowOperationsRequest, options?: AxiosRequestConfig): AxiosPromise<FlowOperations>;
|
|
6928
7537
|
/**
|
|
6929
7538
|
* Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.
|
|
6930
7539
|
* @summary List LLM Provider Models
|
|
@@ -6989,6 +7598,33 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
6989
7598
|
* @memberof ActionsApi
|
|
6990
7599
|
*/
|
|
6991
7600
|
retrieveExecutionMetadata(requestParameters: ActionsApiRetrieveExecutionMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<ResultCacheMetadata>;
|
|
7601
|
+
/**
|
|
7602
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
7603
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
7604
|
+
* @param {ActionsApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
7605
|
+
* @param {*} [options] Override http request option.
|
|
7606
|
+
* @throws {RequiredError}
|
|
7607
|
+
* @memberof ActionsApi
|
|
7608
|
+
*/
|
|
7609
|
+
retrieveFlowResultBinary(requestParameters: ActionsApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
7610
|
+
/**
|
|
7611
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
7612
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
7613
|
+
* @param {ActionsApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
7614
|
+
* @param {*} [options] Override http request option.
|
|
7615
|
+
* @throws {RequiredError}
|
|
7616
|
+
* @memberof ActionsApi
|
|
7617
|
+
*/
|
|
7618
|
+
retrieveFlowResultMetadata(requestParameters: ActionsApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<FlowResultMetadata>;
|
|
7619
|
+
/**
|
|
7620
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
7621
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
7622
|
+
* @param {ActionsApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
7623
|
+
* @param {*} [options] Override http request option.
|
|
7624
|
+
* @throws {RequiredError}
|
|
7625
|
+
* @memberof ActionsApi
|
|
7626
|
+
*/
|
|
7627
|
+
retrieveFlowResultTable(requestParameters: ActionsApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig): AxiosPromise<FlowTableResult>;
|
|
6992
7628
|
/**
|
|
6993
7629
|
* Gets a single execution result.
|
|
6994
7630
|
* @summary Get a single execution result
|
|
@@ -8149,6 +8785,418 @@ export declare class ComputationApi extends BaseAPI implements ComputationApiInt
|
|
|
8149
8785
|
*/
|
|
8150
8786
|
retrieveResultBinary(requestParameters: ComputationApiRetrieveResultBinaryRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
8151
8787
|
}
|
|
8788
|
+
/**
|
|
8789
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
8790
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
8791
|
+
* @param {string} workspaceId Workspace identifier
|
|
8792
|
+
* @param {AfmCancelTokens} afmCancelTokens
|
|
8793
|
+
* @param {*} [options] Override http request option.
|
|
8794
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8795
|
+
* @throws {RequiredError}
|
|
8796
|
+
*/
|
|
8797
|
+
export declare function FlowApiAxiosParamCreator_CancelFlows(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8798
|
+
/**
|
|
8799
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
8800
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
8801
|
+
* @param {string} workspaceId Workspace identifier
|
|
8802
|
+
* @param {FlowRequest} flowRequest
|
|
8803
|
+
* @param {*} [options] Override http request option.
|
|
8804
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8805
|
+
* @throws {RequiredError}
|
|
8806
|
+
*/
|
|
8807
|
+
export declare function FlowApiAxiosParamCreator_ExecuteFlow(workspaceId: string, flowRequest: FlowRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8808
|
+
/**
|
|
8809
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
8810
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
8811
|
+
* @param {string} workspaceId Workspace identifier
|
|
8812
|
+
* @param {*} [options] Override http request option.
|
|
8813
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8814
|
+
* @throws {RequiredError}
|
|
8815
|
+
*/
|
|
8816
|
+
export declare function FlowApiAxiosParamCreator_ListFlowOperations(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8817
|
+
/**
|
|
8818
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
8819
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
8820
|
+
* @param {string} workspaceId Workspace identifier
|
|
8821
|
+
* @param {string} resultId Result ID
|
|
8822
|
+
* @param {number} [rowOffset] Index of the first row to return. The default is 0.
|
|
8823
|
+
* @param {number} [rowLimit] Maximum number of rows to return. The default is all remaining rows.
|
|
8824
|
+
* @param {number} [columnOffset] Index of the first column to return. The default is 0.
|
|
8825
|
+
* @param {number} [columnLimit] Maximum number of columns to return. The default is all remaining columns.
|
|
8826
|
+
* @param {*} [options] Override http request option.
|
|
8827
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8828
|
+
* @throws {RequiredError}
|
|
8829
|
+
*/
|
|
8830
|
+
export declare function FlowApiAxiosParamCreator_RetrieveFlowResultBinary(workspaceId: string, resultId: string, rowOffset?: number, rowLimit?: number, columnOffset?: number, columnLimit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8831
|
+
/**
|
|
8832
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
8833
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
8834
|
+
* @param {string} workspaceId Workspace identifier
|
|
8835
|
+
* @param {string} resultId Result ID
|
|
8836
|
+
* @param {*} [options] Override http request option.
|
|
8837
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8838
|
+
* @throws {RequiredError}
|
|
8839
|
+
*/
|
|
8840
|
+
export declare function FlowApiAxiosParamCreator_RetrieveFlowResultMetadata(workspaceId: string, resultId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8841
|
+
/**
|
|
8842
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
8843
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
8844
|
+
* @param {string} workspaceId Workspace identifier
|
|
8845
|
+
* @param {string} resultId Result ID
|
|
8846
|
+
* @param {number} [rowOffset] Index of the first row to return. The default is 0.
|
|
8847
|
+
* @param {number} [rowLimit] Maximum number of rows to return. The default is all remaining rows.
|
|
8848
|
+
* @param {number} [columnOffset] Index of the first column to return. The default is 0.
|
|
8849
|
+
* @param {number} [columnLimit] Maximum number of columns to return. The default is all remaining columns.
|
|
8850
|
+
* @param {*} [options] Override http request option.
|
|
8851
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8852
|
+
* @throws {RequiredError}
|
|
8853
|
+
*/
|
|
8854
|
+
export declare function FlowApiAxiosParamCreator_RetrieveFlowResultTable(workspaceId: string, resultId: string, rowOffset?: number, rowLimit?: number, columnOffset?: number, columnLimit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
8855
|
+
/**
|
|
8856
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
8857
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
8858
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8859
|
+
* @param {string} basePath Base path.
|
|
8860
|
+
* @param {FlowApiCancelFlowsRequest} requestParameters Request parameters.
|
|
8861
|
+
* @param {*} [options] Override http request option.
|
|
8862
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8863
|
+
* @throws {RequiredError}
|
|
8864
|
+
*/
|
|
8865
|
+
export declare function FlowApi_CancelFlows(axios: AxiosInstance, basePath: string, requestParameters: FlowApiCancelFlowsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmCancelTokens>;
|
|
8866
|
+
/**
|
|
8867
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
8868
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
8869
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8870
|
+
* @param {string} basePath Base path.
|
|
8871
|
+
* @param {FlowApiExecuteFlowRequest} requestParameters Request parameters.
|
|
8872
|
+
* @param {*} [options] Override http request option.
|
|
8873
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8874
|
+
* @throws {RequiredError}
|
|
8875
|
+
*/
|
|
8876
|
+
export declare function FlowApi_ExecuteFlow(axios: AxiosInstance, basePath: string, requestParameters: FlowApiExecuteFlowRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowExecutionResponse>;
|
|
8877
|
+
/**
|
|
8878
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
8879
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
8880
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8881
|
+
* @param {string} basePath Base path.
|
|
8882
|
+
* @param {FlowApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
8883
|
+
* @param {*} [options] Override http request option.
|
|
8884
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8885
|
+
* @throws {RequiredError}
|
|
8886
|
+
*/
|
|
8887
|
+
export declare function FlowApi_ListFlowOperations(axios: AxiosInstance, basePath: string, requestParameters: FlowApiListFlowOperationsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowOperations>;
|
|
8888
|
+
/**
|
|
8889
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
8890
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
8891
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8892
|
+
* @param {string} basePath Base path.
|
|
8893
|
+
* @param {FlowApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
8894
|
+
* @param {*} [options] Override http request option.
|
|
8895
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8896
|
+
* @throws {RequiredError}
|
|
8897
|
+
*/
|
|
8898
|
+
export declare function FlowApi_RetrieveFlowResultBinary(axios: AxiosInstance, basePath: string, requestParameters: FlowApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
|
|
8899
|
+
/**
|
|
8900
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
8901
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
8902
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8903
|
+
* @param {string} basePath Base path.
|
|
8904
|
+
* @param {FlowApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
8905
|
+
* @param {*} [options] Override http request option.
|
|
8906
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8907
|
+
* @throws {RequiredError}
|
|
8908
|
+
*/
|
|
8909
|
+
export declare function FlowApi_RetrieveFlowResultMetadata(axios: AxiosInstance, basePath: string, requestParameters: FlowApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowResultMetadata>;
|
|
8910
|
+
/**
|
|
8911
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
8912
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
8913
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8914
|
+
* @param {string} basePath Base path.
|
|
8915
|
+
* @param {FlowApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
8916
|
+
* @param {*} [options] Override http request option.
|
|
8917
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8918
|
+
* @throws {RequiredError}
|
|
8919
|
+
*/
|
|
8920
|
+
export declare function FlowApi_RetrieveFlowResultTable(axios: AxiosInstance, basePath: string, requestParameters: FlowApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<FlowTableResult>;
|
|
8921
|
+
/**
|
|
8922
|
+
* FlowApi - interface
|
|
8923
|
+
* @export
|
|
8924
|
+
* @interface FlowApi
|
|
8925
|
+
*/
|
|
8926
|
+
export interface FlowApiInterface {
|
|
8927
|
+
/**
|
|
8928
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
8929
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
8930
|
+
* @param {FlowApiCancelFlowsRequest} requestParameters Request parameters.
|
|
8931
|
+
* @param {*} [options] Override http request option.
|
|
8932
|
+
* @throws {RequiredError}
|
|
8933
|
+
* @memberof FlowApiInterface
|
|
8934
|
+
*/
|
|
8935
|
+
cancelFlows(requestParameters: FlowApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
8936
|
+
/**
|
|
8937
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
8938
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
8939
|
+
* @param {FlowApiExecuteFlowRequest} requestParameters Request parameters.
|
|
8940
|
+
* @param {*} [options] Override http request option.
|
|
8941
|
+
* @throws {RequiredError}
|
|
8942
|
+
* @memberof FlowApiInterface
|
|
8943
|
+
*/
|
|
8944
|
+
executeFlow(requestParameters: FlowApiExecuteFlowRequest, options?: AxiosRequestConfig): AxiosPromise<FlowExecutionResponse>;
|
|
8945
|
+
/**
|
|
8946
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
8947
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
8948
|
+
* @param {FlowApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
8949
|
+
* @param {*} [options] Override http request option.
|
|
8950
|
+
* @throws {RequiredError}
|
|
8951
|
+
* @memberof FlowApiInterface
|
|
8952
|
+
*/
|
|
8953
|
+
listFlowOperations(requestParameters: FlowApiListFlowOperationsRequest, options?: AxiosRequestConfig): AxiosPromise<FlowOperations>;
|
|
8954
|
+
/**
|
|
8955
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
8956
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
8957
|
+
* @param {FlowApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
8958
|
+
* @param {*} [options] Override http request option.
|
|
8959
|
+
* @throws {RequiredError}
|
|
8960
|
+
* @memberof FlowApiInterface
|
|
8961
|
+
*/
|
|
8962
|
+
retrieveFlowResultBinary(requestParameters: FlowApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
8963
|
+
/**
|
|
8964
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
8965
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
8966
|
+
* @param {FlowApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
8967
|
+
* @param {*} [options] Override http request option.
|
|
8968
|
+
* @throws {RequiredError}
|
|
8969
|
+
* @memberof FlowApiInterface
|
|
8970
|
+
*/
|
|
8971
|
+
retrieveFlowResultMetadata(requestParameters: FlowApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<FlowResultMetadata>;
|
|
8972
|
+
/**
|
|
8973
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
8974
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
8975
|
+
* @param {FlowApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
8976
|
+
* @param {*} [options] Override http request option.
|
|
8977
|
+
* @throws {RequiredError}
|
|
8978
|
+
* @memberof FlowApiInterface
|
|
8979
|
+
*/
|
|
8980
|
+
retrieveFlowResultTable(requestParameters: FlowApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig): AxiosPromise<FlowTableResult>;
|
|
8981
|
+
}
|
|
8982
|
+
/**
|
|
8983
|
+
* Request parameters for cancelFlows operation in FlowApi.
|
|
8984
|
+
* @export
|
|
8985
|
+
* @interface FlowApiCancelFlowsRequest
|
|
8986
|
+
*/
|
|
8987
|
+
export interface FlowApiCancelFlowsRequest {
|
|
8988
|
+
/**
|
|
8989
|
+
* Workspace identifier
|
|
8990
|
+
* @type {string}
|
|
8991
|
+
* @memberof FlowApiCancelFlows
|
|
8992
|
+
*/
|
|
8993
|
+
readonly workspaceId: string;
|
|
8994
|
+
/**
|
|
8995
|
+
*
|
|
8996
|
+
* @type {AfmCancelTokens}
|
|
8997
|
+
* @memberof FlowApiCancelFlows
|
|
8998
|
+
*/
|
|
8999
|
+
readonly afmCancelTokens: AfmCancelTokens;
|
|
9000
|
+
}
|
|
9001
|
+
/**
|
|
9002
|
+
* Request parameters for executeFlow operation in FlowApi.
|
|
9003
|
+
* @export
|
|
9004
|
+
* @interface FlowApiExecuteFlowRequest
|
|
9005
|
+
*/
|
|
9006
|
+
export interface FlowApiExecuteFlowRequest {
|
|
9007
|
+
/**
|
|
9008
|
+
* Workspace identifier
|
|
9009
|
+
* @type {string}
|
|
9010
|
+
* @memberof FlowApiExecuteFlow
|
|
9011
|
+
*/
|
|
9012
|
+
readonly workspaceId: string;
|
|
9013
|
+
/**
|
|
9014
|
+
*
|
|
9015
|
+
* @type {FlowRequest}
|
|
9016
|
+
* @memberof FlowApiExecuteFlow
|
|
9017
|
+
*/
|
|
9018
|
+
readonly flowRequest: FlowRequest;
|
|
9019
|
+
}
|
|
9020
|
+
/**
|
|
9021
|
+
* Request parameters for listFlowOperations operation in FlowApi.
|
|
9022
|
+
* @export
|
|
9023
|
+
* @interface FlowApiListFlowOperationsRequest
|
|
9024
|
+
*/
|
|
9025
|
+
export interface FlowApiListFlowOperationsRequest {
|
|
9026
|
+
/**
|
|
9027
|
+
* Workspace identifier
|
|
9028
|
+
* @type {string}
|
|
9029
|
+
* @memberof FlowApiListFlowOperations
|
|
9030
|
+
*/
|
|
9031
|
+
readonly workspaceId: string;
|
|
9032
|
+
}
|
|
9033
|
+
/**
|
|
9034
|
+
* Request parameters for retrieveFlowResultBinary operation in FlowApi.
|
|
9035
|
+
* @export
|
|
9036
|
+
* @interface FlowApiRetrieveFlowResultBinaryRequest
|
|
9037
|
+
*/
|
|
9038
|
+
export interface FlowApiRetrieveFlowResultBinaryRequest {
|
|
9039
|
+
/**
|
|
9040
|
+
* Workspace identifier
|
|
9041
|
+
* @type {string}
|
|
9042
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9043
|
+
*/
|
|
9044
|
+
readonly workspaceId: string;
|
|
9045
|
+
/**
|
|
9046
|
+
* Result ID
|
|
9047
|
+
* @type {string}
|
|
9048
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9049
|
+
*/
|
|
9050
|
+
readonly resultId: string;
|
|
9051
|
+
/**
|
|
9052
|
+
* Index of the first row to return. The default is 0.
|
|
9053
|
+
* @type {number}
|
|
9054
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9055
|
+
*/
|
|
9056
|
+
readonly rowOffset?: number;
|
|
9057
|
+
/**
|
|
9058
|
+
* Maximum number of rows to return. The default is all remaining rows.
|
|
9059
|
+
* @type {number}
|
|
9060
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9061
|
+
*/
|
|
9062
|
+
readonly rowLimit?: number;
|
|
9063
|
+
/**
|
|
9064
|
+
* Index of the first column to return. The default is 0.
|
|
9065
|
+
* @type {number}
|
|
9066
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9067
|
+
*/
|
|
9068
|
+
readonly columnOffset?: number;
|
|
9069
|
+
/**
|
|
9070
|
+
* Maximum number of columns to return. The default is all remaining columns.
|
|
9071
|
+
* @type {number}
|
|
9072
|
+
* @memberof FlowApiRetrieveFlowResultBinary
|
|
9073
|
+
*/
|
|
9074
|
+
readonly columnLimit?: number;
|
|
9075
|
+
}
|
|
9076
|
+
/**
|
|
9077
|
+
* Request parameters for retrieveFlowResultMetadata operation in FlowApi.
|
|
9078
|
+
* @export
|
|
9079
|
+
* @interface FlowApiRetrieveFlowResultMetadataRequest
|
|
9080
|
+
*/
|
|
9081
|
+
export interface FlowApiRetrieveFlowResultMetadataRequest {
|
|
9082
|
+
/**
|
|
9083
|
+
* Workspace identifier
|
|
9084
|
+
* @type {string}
|
|
9085
|
+
* @memberof FlowApiRetrieveFlowResultMetadata
|
|
9086
|
+
*/
|
|
9087
|
+
readonly workspaceId: string;
|
|
9088
|
+
/**
|
|
9089
|
+
* Result ID
|
|
9090
|
+
* @type {string}
|
|
9091
|
+
* @memberof FlowApiRetrieveFlowResultMetadata
|
|
9092
|
+
*/
|
|
9093
|
+
readonly resultId: string;
|
|
9094
|
+
}
|
|
9095
|
+
/**
|
|
9096
|
+
* Request parameters for retrieveFlowResultTable operation in FlowApi.
|
|
9097
|
+
* @export
|
|
9098
|
+
* @interface FlowApiRetrieveFlowResultTableRequest
|
|
9099
|
+
*/
|
|
9100
|
+
export interface FlowApiRetrieveFlowResultTableRequest {
|
|
9101
|
+
/**
|
|
9102
|
+
* Workspace identifier
|
|
9103
|
+
* @type {string}
|
|
9104
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9105
|
+
*/
|
|
9106
|
+
readonly workspaceId: string;
|
|
9107
|
+
/**
|
|
9108
|
+
* Result ID
|
|
9109
|
+
* @type {string}
|
|
9110
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9111
|
+
*/
|
|
9112
|
+
readonly resultId: string;
|
|
9113
|
+
/**
|
|
9114
|
+
* Index of the first row to return. The default is 0.
|
|
9115
|
+
* @type {number}
|
|
9116
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9117
|
+
*/
|
|
9118
|
+
readonly rowOffset?: number;
|
|
9119
|
+
/**
|
|
9120
|
+
* Maximum number of rows to return. The default is all remaining rows.
|
|
9121
|
+
* @type {number}
|
|
9122
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9123
|
+
*/
|
|
9124
|
+
readonly rowLimit?: number;
|
|
9125
|
+
/**
|
|
9126
|
+
* Index of the first column to return. The default is 0.
|
|
9127
|
+
* @type {number}
|
|
9128
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9129
|
+
*/
|
|
9130
|
+
readonly columnOffset?: number;
|
|
9131
|
+
/**
|
|
9132
|
+
* Maximum number of columns to return. The default is all remaining columns.
|
|
9133
|
+
* @type {number}
|
|
9134
|
+
* @memberof FlowApiRetrieveFlowResultTable
|
|
9135
|
+
*/
|
|
9136
|
+
readonly columnLimit?: number;
|
|
9137
|
+
}
|
|
9138
|
+
/**
|
|
9139
|
+
* FlowApi - object-oriented interface
|
|
9140
|
+
* @export
|
|
9141
|
+
* @class FlowApi
|
|
9142
|
+
* @extends {BaseAPI}
|
|
9143
|
+
*/
|
|
9144
|
+
export declare class FlowApi extends BaseAPI implements FlowApiInterface {
|
|
9145
|
+
/**
|
|
9146
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.
|
|
9147
|
+
* @summary (EXPERIMENTAL) Apply the given cancel tokens to flows
|
|
9148
|
+
* @param {FlowApiCancelFlowsRequest} requestParameters Request parameters.
|
|
9149
|
+
* @param {*} [options] Override http request option.
|
|
9150
|
+
* @throws {RequiredError}
|
|
9151
|
+
* @memberof FlowApi
|
|
9152
|
+
*/
|
|
9153
|
+
cancelFlows(requestParameters: FlowApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
|
|
9154
|
+
/**
|
|
9155
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.
|
|
9156
|
+
* @summary (EXPERIMENTAL) Execute a flow
|
|
9157
|
+
* @param {FlowApiExecuteFlowRequest} requestParameters Request parameters.
|
|
9158
|
+
* @param {*} [options] Override http request option.
|
|
9159
|
+
* @throws {RequiredError}
|
|
9160
|
+
* @memberof FlowApi
|
|
9161
|
+
*/
|
|
9162
|
+
executeFlow(requestParameters: FlowApiExecuteFlowRequest, options?: AxiosRequestConfig): AxiosPromise<FlowExecutionResponse>;
|
|
9163
|
+
/**
|
|
9164
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.
|
|
9165
|
+
* @summary (EXPERIMENTAL) List the operations of flows
|
|
9166
|
+
* @param {FlowApiListFlowOperationsRequest} requestParameters Request parameters.
|
|
9167
|
+
* @param {*} [options] Override http request option.
|
|
9168
|
+
* @throws {RequiredError}
|
|
9169
|
+
* @memberof FlowApi
|
|
9170
|
+
*/
|
|
9171
|
+
listFlowOperations(requestParameters: FlowApiListFlowOperationsRequest, options?: AxiosRequestConfig): AxiosPromise<FlowOperations>;
|
|
9172
|
+
/**
|
|
9173
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.
|
|
9174
|
+
* @summary (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format
|
|
9175
|
+
* @param {FlowApiRetrieveFlowResultBinaryRequest} requestParameters Request parameters.
|
|
9176
|
+
* @param {*} [options] Override http request option.
|
|
9177
|
+
* @throws {RequiredError}
|
|
9178
|
+
* @memberof FlowApi
|
|
9179
|
+
*/
|
|
9180
|
+
retrieveFlowResultBinary(requestParameters: FlowApiRetrieveFlowResultBinaryRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
9181
|
+
/**
|
|
9182
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.
|
|
9183
|
+
* @summary (EXPERIMENTAL) Get the metadata of a flow result
|
|
9184
|
+
* @param {FlowApiRetrieveFlowResultMetadataRequest} requestParameters Request parameters.
|
|
9185
|
+
* @param {*} [options] Override http request option.
|
|
9186
|
+
* @throws {RequiredError}
|
|
9187
|
+
* @memberof FlowApi
|
|
9188
|
+
*/
|
|
9189
|
+
retrieveFlowResultMetadata(requestParameters: FlowApiRetrieveFlowResultMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<FlowResultMetadata>;
|
|
9190
|
+
/**
|
|
9191
|
+
* Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.
|
|
9192
|
+
* @summary (EXPERIMENTAL) Get a page of a flow result
|
|
9193
|
+
* @param {FlowApiRetrieveFlowResultTableRequest} requestParameters Request parameters.
|
|
9194
|
+
* @param {*} [options] Override http request option.
|
|
9195
|
+
* @throws {RequiredError}
|
|
9196
|
+
* @memberof FlowApi
|
|
9197
|
+
*/
|
|
9198
|
+
retrieveFlowResultTable(requestParameters: FlowApiRetrieveFlowResultTableRequest, options?: AxiosRequestConfig): AxiosPromise<FlowTableResult>;
|
|
9199
|
+
}
|
|
8152
9200
|
/**
|
|
8153
9201
|
* Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead.
|
|
8154
9202
|
* @summary (REMOVED) Chat with AI
|