@gooddata/api-client-tiger 11.26.0-alpha.1 → 11.26.0-alpha.3

package/esm/generated/afm-rest-api/api.js

@@ -2411,7 +2411,7 @@ export async function ActionsApiAxiosParamCreator_PatchDocument(workspaceId, fil
 }
 // ActionsApi FP - ActionsApiAxiosParamCreator
 /**
- * Returns a list of available LLM Endpoints
+ * Will be soon removed and replaced by LlmProvider-based resolution.
  * @summary Get Active LLM Endpoints for this workspace
  * @param {string} workspaceId Workspace identifier
  * @param {*} [options] Override http request option.
@@ -2539,6 +2539,49 @@ export async function ActionsApiAxiosParamCreator_RetrieveResult(workspaceId, re
     };
 }
 // ActionsApi FP - ActionsApiAxiosParamCreator
+/**
+ * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+ * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} resultId Result ID
+ * @param {string} [xGDCCANCELTOKEN]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function ActionsApiAxiosParamCreator_RetrieveResultBinary(workspaceId, resultId, xGDCCANCELTOKEN, options = {}, configuration) {
+    // verify required parameter 'workspaceId' is not null or undefined
+    assertParamExists('retrieveResultBinary', 'workspaceId', workspaceId);
+    // verify required parameter 'resultId' is not null or undefined
+    assertParamExists('retrieveResultBinary', 'resultId', resultId);
+    const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary`
+        .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+        .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId)));
+    // use dummy base URL string because the URL constructor only accepts absolute URLs.
+    const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+    let baseOptions;
+    if (configuration) {
+        baseOptions = configuration.baseOptions;
+    }
+    const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+    const localVarHeaderParameter = {};
+    const localVarQueryParameter = {};
+    if (xGDCCANCELTOKEN !== undefined && xGDCCANCELTOKEN !== null) {
+        localVarHeaderParameter['X-GDC-CANCEL-TOKEN'] = String(xGDCCANCELTOKEN);
+    }
+    setSearchParams(localVarUrlObj, localVarQueryParameter);
+    const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
+    localVarRequestOptions.headers = {
+        ...localVarHeaderParameter,
+        ...headersFromBaseOptions,
+        ...options.headers,
+    };
+    return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+    };
+}
+// ActionsApi FP - ActionsApiAxiosParamCreator
 /**
  *
  * @param {string} workspaceId Workspace identifier
@@ -2840,7 +2883,7 @@ export async function ActionsApiAxiosParamCreator_UpsertDocument(workspaceId, up
 }
 // ActionsApi FP - ActionsApiAxiosParamCreator
 /**
- * Validates LLM endpoint with provided parameters.
+ * Will be soon removed and replaced by testLlmProvider.
  * @summary Validate LLM Endpoint
  * @param {ValidateLLMEndpointRequest} validateLLMEndpointRequest
  * @param {*} [options] Override http request option.
@@ -2886,7 +2929,7 @@ export async function ActionsApiAxiosParamCreator_ValidateLLMEndpoint(validateLL
 }
 // ActionsApi FP - ActionsApiAxiosParamCreator
 /**
- * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+ * Will be soon removed and replaced by testLlmProviderById.
  * @summary Validate LLM Endpoint By Id
  * @param {string} llmEndpointId
  * @param {ValidateLLMEndpointByIdRequest} [validateLLMEndpointByIdRequest]
@@ -3511,7 +3554,7 @@ export async function ActionsApi_PatchDocument(axios, basePath, requestParameter
 }
 // ActionsApi Api FP
 /**
- * Returns a list of available LLM Endpoints
+ * Will be soon removed and replaced by LlmProvider-based resolution.
  * @summary Get Active LLM Endpoints for this workspace
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -3555,6 +3598,21 @@ export async function ActionsApi_RetrieveResult(axios, basePath, requestParamete
     return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
 }
 // ActionsApi Api FP
+/**
+ * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+ * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiRetrieveResultBinaryRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function ActionsApi_RetrieveResultBinary(axios, basePath, requestParameters, options, configuration) {
+    const localVarAxiosArgs = await ActionsApiAxiosParamCreator_RetrieveResultBinary(requestParameters.workspaceId, requestParameters.resultId, requestParameters.xGDCCANCELTOKEN, options || {}, configuration);
+    return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
+}
+// ActionsApi Api FP
 /**
  *
  * @param {AxiosInstance} axios Axios instance.
@@ -3659,7 +3717,7 @@ export async function ActionsApi_UpsertDocument(axios, basePath, requestParamete
 }
 // ActionsApi Api FP
 /**
- * Validates LLM endpoint with provided parameters.
+ * Will be soon removed and replaced by testLlmProvider.
  * @summary Validate LLM Endpoint
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -3674,7 +3732,7 @@ export async function ActionsApi_ValidateLLMEndpoint(axios, basePath, requestPar
 }
 // ActionsApi Api FP
 /**
- * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+ * Will be soon removed and replaced by testLlmProviderById.
  * @summary Validate LLM Endpoint By Id
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -4116,10 +4174,11 @@ export class ActionsApi extends BaseAPI {
         return ActionsApi_PatchDocument(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Returns a list of available LLM Endpoints
+     * Will be soon removed and replaced by LlmProvider-based resolution.
      * @summary Get Active LLM Endpoints for this workspace
      * @param {ActionsApiResolveLlmEndpointsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActionsApi
      */
@@ -4148,6 +4207,17 @@ export class ActionsApi extends BaseAPI {
     retrieveResult(requestParameters, options) {
         return ActionsApi_RetrieveResult(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
+    /**
+     * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+     * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+     * @param {ActionsApiRetrieveResultBinaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    retrieveResultBinary(requestParameters, options) {
+        return ActionsApi_RetrieveResultBinary(this.axios, this.basePath, requestParameters, options, this.configuration);
+    }
     /**
      *
      * @param {ActionsApiSearchKnowledgeRequest} requestParameters Request parameters.
@@ -4224,10 +4294,11 @@ export class ActionsApi extends BaseAPI {
         return ActionsApi_UpsertDocument(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Validates LLM endpoint with provided parameters.
+     * Will be soon removed and replaced by testLlmProvider.
      * @summary Validate LLM Endpoint
      * @param {ActionsApiValidateLLMEndpointRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActionsApi
      */
@@ -4235,10 +4306,11 @@ export class ActionsApi extends BaseAPI {
         return ActionsApi_ValidateLLMEndpoint(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+     * Will be soon removed and replaced by testLlmProviderById.
      * @summary Validate LLM Endpoint By Id
      * @param {ActionsApiValidateLLMEndpointByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActionsApi
      */
@@ -4955,6 +5027,49 @@ export async function ComputationApiAxiosParamCreator_RetrieveResult(workspaceId
         options: localVarRequestOptions,
     };
 }
+// ComputationApi FP - ComputationApiAxiosParamCreator
+/**
+ * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+ * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} resultId Result ID
+ * @param {string} [xGDCCANCELTOKEN]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function ComputationApiAxiosParamCreator_RetrieveResultBinary(workspaceId, resultId, xGDCCANCELTOKEN, options = {}, configuration) {
+    // verify required parameter 'workspaceId' is not null or undefined
+    assertParamExists('retrieveResultBinary', 'workspaceId', workspaceId);
+    // verify required parameter 'resultId' is not null or undefined
+    assertParamExists('retrieveResultBinary', 'resultId', resultId);
+    const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary`
+        .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+        .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId)));
+    // use dummy base URL string because the URL constructor only accepts absolute URLs.
+    const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+    let baseOptions;
+    if (configuration) {
+        baseOptions = configuration.baseOptions;
+    }
+    const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+    const localVarHeaderParameter = {};
+    const localVarQueryParameter = {};
+    if (xGDCCANCELTOKEN !== undefined && xGDCCANCELTOKEN !== null) {
+        localVarHeaderParameter['X-GDC-CANCEL-TOKEN'] = String(xGDCCANCELTOKEN);
+    }
+    setSearchParams(localVarUrlObj, localVarQueryParameter);
+    const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
+    localVarRequestOptions.headers = {
+        ...localVarHeaderParameter,
+        ...headersFromBaseOptions,
+        ...options.headers,
+    };
+    return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+    };
+}
 // ComputationApi Api FP
 /**
  * Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.
@@ -5165,6 +5280,21 @@ export async function ComputationApi_RetrieveResult(axios, basePath, requestPara
     const localVarAxiosArgs = await ComputationApiAxiosParamCreator_RetrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, requestParameters.xGDCCANCELTOKEN, options || {}, configuration);
     return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
 }
+// ComputationApi Api FP
+/**
+ * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+ * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ComputationApiRetrieveResultBinaryRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function ComputationApi_RetrieveResultBinary(axios, basePath, requestParameters, options, configuration) {
+    const localVarAxiosArgs = await ComputationApiAxiosParamCreator_RetrieveResultBinary(requestParameters.workspaceId, requestParameters.resultId, requestParameters.xGDCCANCELTOKEN, options || {}, configuration);
+    return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
+}
 /**
  * ComputationApi - object-oriented interface
  * @export
@@ -5326,6 +5456,17 @@ export class ComputationApi extends BaseAPI {
     retrieveResult(requestParameters, options) {
         return ComputationApi_RetrieveResult(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
+    /**
+     * (BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.
+     * @summary (BETA) Get a single execution result in Apache Arrow File or Stream format
+     * @param {ComputationApiRetrieveResultBinaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    retrieveResultBinary(requestParameters, options) {
+        return ComputationApi_RetrieveResultBinary(this.axios, this.basePath, requestParameters, options, this.configuration);
+    }
 }
 // SmartFunctionsApi FP - SmartFunctionsApiAxiosParamCreator
 /**
@@ -6204,7 +6345,7 @@ export async function SmartFunctionsApiAxiosParamCreator_MemoryCreatedByUsers(wo
 }
 // SmartFunctionsApi FP - SmartFunctionsApiAxiosParamCreator
 /**
- * Returns a list of available LLM Endpoints
+ * Will be soon removed and replaced by LlmProvider-based resolution.
  * @summary Get Active LLM Endpoints for this workspace
  * @param {string} workspaceId Workspace identifier
  * @param {*} [options] Override http request option.
@@ -6438,7 +6579,7 @@ export async function SmartFunctionsApiAxiosParamCreator_TriggerQualityIssuesCal
 }
 // SmartFunctionsApi FP - SmartFunctionsApiAxiosParamCreator
 /**
- * Validates LLM endpoint with provided parameters.
+ * Will be soon removed and replaced by testLlmProvider.
  * @summary Validate LLM Endpoint
  * @param {ValidateLLMEndpointRequest} validateLLMEndpointRequest
  * @param {*} [options] Override http request option.
@@ -6484,7 +6625,7 @@ export async function SmartFunctionsApiAxiosParamCreator_ValidateLLMEndpoint(val
 }
 // SmartFunctionsApi FP - SmartFunctionsApiAxiosParamCreator
 /**
- * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+ * Will be soon removed and replaced by testLlmProviderById.
  * @summary Validate LLM Endpoint By Id
  * @param {string} llmEndpointId
  * @param {ValidateLLMEndpointByIdRequest} [validateLLMEndpointByIdRequest]
@@ -6817,7 +6958,7 @@ export async function SmartFunctionsApi_MemoryCreatedByUsers(axios, basePath, re
 }
 // SmartFunctionsApi Api FP
 /**
- * Returns a list of available LLM Endpoints
+ * Will be soon removed and replaced by LlmProvider-based resolution.
  * @summary Get Active LLM Endpoints for this workspace
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -6907,7 +7048,7 @@ export async function SmartFunctionsApi_TriggerQualityIssuesCalculation(axios, b
 }
 // SmartFunctionsApi Api FP
 /**
- * Validates LLM endpoint with provided parameters.
+ * Will be soon removed and replaced by testLlmProvider.
  * @summary Validate LLM Endpoint
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -6922,7 +7063,7 @@ export async function SmartFunctionsApi_ValidateLLMEndpoint(axios, basePath, req
 }
 // SmartFunctionsApi Api FP
 /**
- * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+ * Will be soon removed and replaced by testLlmProviderById.
  * @summary Validate LLM Endpoint By Id
  * @param {AxiosInstance} axios Axios instance.
  * @param {string} basePath Base path.
@@ -7152,10 +7293,11 @@ export class SmartFunctionsApi extends BaseAPI {
         return SmartFunctionsApi_MemoryCreatedByUsers(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Returns a list of available LLM Endpoints
+     * Will be soon removed and replaced by LlmProvider-based resolution.
      * @summary Get Active LLM Endpoints for this workspace
      * @param {SmartFunctionsApiResolveLlmEndpointsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SmartFunctionsApi
      */
@@ -7218,10 +7360,11 @@ export class SmartFunctionsApi extends BaseAPI {
         return SmartFunctionsApi_TriggerQualityIssuesCalculation(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Validates LLM endpoint with provided parameters.
+     * Will be soon removed and replaced by testLlmProvider.
      * @summary Validate LLM Endpoint
      * @param {SmartFunctionsApiValidateLLMEndpointRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SmartFunctionsApi
      */
@@ -7229,10 +7372,11 @@ export class SmartFunctionsApi extends BaseAPI {
         return SmartFunctionsApi_ValidateLLMEndpoint(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
     /**
-     * Validates existing LLM endpoint with provided parameters and updates it if they are valid.
+     * Will be soon removed and replaced by testLlmProviderById.
      * @summary Validate LLM Endpoint By Id
      * @param {SmartFunctionsApiValidateLLMEndpointByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof SmartFunctionsApi
      */