@gooddata/api-client-tiger 11.13.0-alpha.6 → 11.14.0-alpha.0

package/esm/generated/afm-rest-api/api.d.ts

@@ -382,7 +382,7 @@ export interface ChangeAnalysisParams {
     /**
      * Optional filters to apply
      */
-    filters: Array<ChangeAnalysisRequestFiltersInner>;
+    filters: Array<OutlierDetectionRequestFiltersInner>;
     /**
      * Whether to use smart attribute selection
      */
@@ -409,7 +409,7 @@ export interface ChangeAnalysisRequest {
     /**
      * Optional filters to apply.
      */
-    filters?: Array<ChangeAnalysisRequestFiltersInner>;
+    filters?: Array<OutlierDetectionRequestFiltersInner>;
     /**
      * Auxiliary measures
      */
@@ -419,10 +419,6 @@ export interface ChangeAnalysisRequest {
      */
     useSmartAttributeSelection?: boolean;
 }
-/**
- * @type ChangeAnalysisRequestFiltersInner
- */
-export type ChangeAnalysisRequestFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
 /**
  * Response for change analysis computation
  */
@@ -475,6 +471,7 @@ export interface ChatHistoryInteraction {
      * User feedback.
      */
     userFeedback?: ChatHistoryInteractionUserFeedbackEnum;
+    reasoning?: Reasoning;
 }
 export type ChatHistoryInteractionUserFeedbackEnum = "POSITIVE" | "NEGATIVE" | "NONE";
 export interface ChatHistoryRequest {
@@ -582,6 +579,7 @@ export interface ChatResult {
      * Chat History interaction ID. Unique ID for each interaction.
      */
     chatHistoryInteractionId?: string;
+    reasoning?: Reasoning;
 }
 export interface ChatUsageResponse {
     /**
@@ -688,7 +686,7 @@ export interface CreatedVisualizations {
      */
     objects: Array<CreatedVisualization>;
     /**
-     * Reasoning from LLM. Description of how and why the answer was generated.
+     * DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.
      */
     reasoning: string;
     /**
@@ -1052,7 +1050,7 @@ export interface FoundObjects {
      */
     objects: Array<SearchResultObject>;
     /**
-     * Reasoning from LLM. Description of how and why the answer was generated.
+     * DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.
      */
     reasoning: string;
 }
@@ -1311,6 +1309,37 @@ export interface NegativeAttributeFilterNegativeAttributeFilter {
     applyOnResult?: boolean;
     label: AfmIdentifier;
 }
+export interface OutlierDetectionRequest {
+    measures: Array<MeasureItem>;
+    dateAttribute: AttributeItem;
+    /**
+     * Optional filters to apply
+     */
+    filters?: Array<OutlierDetectionRequestFiltersInner>;
+    /**
+     * Sensitivity level for outlier detection
+     */
+    sensitivity: OutlierDetectionRequestSensitivityEnum;
+    /**
+     * Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
+     */
+    granularity: OutlierDetectionRequestGranularityEnum;
+}
+export type OutlierDetectionRequestSensitivityEnum = "LOW" | "MEDIUM" | "HIGH";
+export type OutlierDetectionRequestGranularityEnum = "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
+/**
+ * @type OutlierDetectionRequestFiltersInner
+ */
+export type OutlierDetectionRequestFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
+export interface OutlierDetectionResponse {
+    links: ExecutionLinks;
+}
+export interface OutlierDetectionResult {
+    attribute: Array<string>;
+    values: {
+        [key: string]: Array<number | null> | null;
+    } | null;
+}
 /**
  * Current page description.
  */
@@ -1508,6 +1537,32 @@ export interface RankingFilterRankingFilter {
     applyOnResult?: boolean;
 }
 export type RankingFilterRankingFilterOperatorEnum = "TOP" | "BOTTOM";
+/**
+ * Reasoning wrapper containing steps taken during request handling.
+ */
+export interface Reasoning {
+    /**
+     * Steps taken during processing, showing the AI\'s reasoning process.
+     */
+    steps: Array<ReasoningStep>;
+    /**
+     * Final answer/reasoning from the use case result.
+     */
+    answer?: string;
+}
+/**
+ * Steps taken during processing, showing the AI\'s reasoning process.
+ */
+export interface ReasoningStep {
+    /**
+     * Title describing this reasoning step.
+     */
+    title: string;
+    /**
+     * Detailed thoughts/messages within this step.
+     */
+    thoughts: Array<Thought>;
+}
 /**
  * A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
  */
@@ -1680,7 +1735,7 @@ export interface SearchResult {
     results: Array<SearchResultObject>;
     relationships: Array<SearchRelationshipObject>;
     /**
-     * If something is not working properly this field will contain explanation.
+     * DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.
      */
     reasoning: string;
 }
@@ -1835,6 +1890,15 @@ export interface Suggestion {
      */
     label: string;
 }
+/**
+ * Detailed thoughts/messages within this step.
+ */
+export interface Thought {
+    /**
+     * The text content of this thought.
+     */
+    text: string;
+}
 /**
  * Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it\'s described in `TotalDimension`
  */
@@ -2224,6 +2288,29 @@ export declare function ActionsApiAxiosParamCreator_KeyDriverAnalysisResult(work
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_MemoryCreatedByUsers(workspaceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Computes outlier detection for the provided execution definition.
+ * @summary (BETA) Outlier Detection
+ * @param {string} workspaceId Workspace identifier
+ * @param {OutlierDetectionRequest} outlierDetectionRequest
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_OutlierDetection(workspaceId: string, outlierDetectionRequest: OutlierDetectionRequest, skipCache?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Gets outlier detection result.
+ * @summary (BETA) Outlier Detection Result
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} resultId Result ID
+ * @param {number} [offset]
+ * @param {number} [limit]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_OutlierDetectionResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Returns a list of available LLM Endpoints
  * @summary Get Active LLM Endpoints for this workspace
@@ -2569,6 +2656,28 @@ export declare function ActionsApi_KeyDriverAnalysisResult(axios: AxiosInstance,
  * @throws {RequiredError}
  */
 export declare function ActionsApi_MemoryCreatedByUsers(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiMemoryCreatedByUsersRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<MemoryItemCreatedByUsers>;
+/**
+ * (BETA) Computes outlier detection for the provided execution definition.
+ * @summary (BETA) Outlier Detection
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiOutlierDetectionRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_OutlierDetection(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiOutlierDetectionRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<OutlierDetectionResponse>;
+/**
+ * (BETA) Gets outlier detection result.
+ * @summary (BETA) Outlier Detection Result
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiOutlierDetectionResultRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_OutlierDetectionResult(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiOutlierDetectionResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<OutlierDetectionResult>;
 /**
  * Returns a list of available LLM Endpoints
  * @summary Get Active LLM Endpoints for this workspace
@@ -2877,6 +2986,24 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     memoryCreatedByUsers(requestParameters: ActionsApiMemoryCreatedByUsersRequest, options?: AxiosRequestConfig): AxiosPromise<MemoryItemCreatedByUsers>;
+    /**
+     * (BETA) Computes outlier detection for the provided execution definition.
+     * @summary (BETA) Outlier Detection
+     * @param {ActionsApiOutlierDetectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    outlierDetection(requestParameters: ActionsApiOutlierDetectionRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResponse>;
+    /**
+     * (BETA) Gets outlier detection result.
+     * @summary (BETA) Outlier Detection Result
+     * @param {ActionsApiOutlierDetectionResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    outlierDetectionResult(requestParameters: ActionsApiOutlierDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResult>;
     /**
      * Returns a list of available LLM Endpoints
      * @summary Get Active LLM Endpoints for this workspace
@@ -3518,6 +3645,62 @@ export interface ActionsApiMemoryCreatedByUsersRequest {
      */
     readonly workspaceId: string;
 }
+/**
+ * Request parameters for outlierDetection operation in ActionsApi.
+ * @export
+ * @interface ActionsApiOutlierDetectionRequest
+ */
+export interface ActionsApiOutlierDetectionRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiOutlierDetection
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {OutlierDetectionRequest}
+     * @memberof ActionsApiOutlierDetection
+     */
+    readonly outlierDetectionRequest: OutlierDetectionRequest;
+    /**
+     * Ignore all caches during execution of current request.
+     * @type {boolean}
+     * @memberof ActionsApiOutlierDetection
+     */
+    readonly skipCache?: boolean;
+}
+/**
+ * Request parameters for outlierDetectionResult operation in ActionsApi.
+ * @export
+ * @interface ActionsApiOutlierDetectionResultRequest
+ */
+export interface ActionsApiOutlierDetectionResultRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiOutlierDetectionResult
+     */
+    readonly workspaceId: string;
+    /**
+     * Result ID
+     * @type {string}
+     * @memberof ActionsApiOutlierDetectionResult
+     */
+    readonly resultId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ActionsApiOutlierDetectionResult
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ActionsApiOutlierDetectionResult
+     */
+    readonly limit?: number;
+}
 /**
  * Request parameters for resolveLlmEndpoints operation in ActionsApi.
  * @export
@@ -3883,6 +4066,24 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     memoryCreatedByUsers(requestParameters: ActionsApiMemoryCreatedByUsersRequest, options?: AxiosRequestConfig): AxiosPromise<MemoryItemCreatedByUsers>;
+    /**
+     * (BETA) Computes outlier detection for the provided execution definition.
+     * @summary (BETA) Outlier Detection
+     * @param {ActionsApiOutlierDetectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    outlierDetection(requestParameters: ActionsApiOutlierDetectionRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResponse>;
+    /**
+     * (BETA) Gets outlier detection result.
+     * @summary (BETA) Outlier Detection Result
+     * @param {ActionsApiOutlierDetectionResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    outlierDetectionResult(requestParameters: ActionsApiOutlierDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResult>;
     /**
      * Returns a list of available LLM Endpoints
      * @summary Get Active LLM Endpoints for this workspace
@@ -4046,6 +4247,29 @@ export declare function ComputationApiAxiosParamCreator_KeyDriverAnalysis(worksp
  * @throws {RequiredError}
  */
 export declare function ComputationApiAxiosParamCreator_KeyDriverAnalysisResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Computes outlier detection for the provided execution definition.
+ * @summary (BETA) Outlier Detection
+ * @param {string} workspaceId Workspace identifier
+ * @param {OutlierDetectionRequest} outlierDetectionRequest
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ComputationApiAxiosParamCreator_OutlierDetection(workspaceId: string, outlierDetectionRequest: OutlierDetectionRequest, skipCache?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Gets outlier detection result.
+ * @summary (BETA) Outlier Detection Result
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} resultId Result ID
+ * @param {number} [offset]
+ * @param {number} [limit]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ComputationApiAxiosParamCreator_OutlierDetectionResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
  * @summary Get a single execution result\'s metadata.
@@ -4169,6 +4393,28 @@ export declare function ComputationApi_KeyDriverAnalysis(axios: AxiosInstance, b
  * @throws {RequiredError}
  */
 export declare function ComputationApi_KeyDriverAnalysisResult(axios: AxiosInstance, basePath: string, requestParameters: ComputationApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<KeyDriversResult>;
+/**
+ * (BETA) Computes outlier detection for the provided execution definition.
+ * @summary (BETA) Outlier Detection
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ComputationApiOutlierDetectionRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ComputationApi_OutlierDetection(axios: AxiosInstance, basePath: string, requestParameters: ComputationApiOutlierDetectionRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<OutlierDetectionResponse>;
+/**
+ * (BETA) Gets outlier detection result.
+ * @summary (BETA) Outlier Detection Result
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ComputationApiOutlierDetectionResultRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ComputationApi_OutlierDetectionResult(axios: AxiosInstance, basePath: string, requestParameters: ComputationApiOutlierDetectionResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<OutlierDetectionResult>;
 /**
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
  * @summary Get a single execution result\'s metadata.
@@ -4278,6 +4524,24 @@ export interface ComputationApiInterface {
      * @memberof ComputationApiInterface
      */
     keyDriverAnalysisResult(requestParameters: ComputationApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<KeyDriversResult>;
+    /**
+     * (BETA) Computes outlier detection for the provided execution definition.
+     * @summary (BETA) Outlier Detection
+     * @param {ComputationApiOutlierDetectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApiInterface
+     */
+    outlierDetection(requestParameters: ComputationApiOutlierDetectionRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResponse>;
+    /**
+     * (BETA) Gets outlier detection result.
+     * @summary (BETA) Outlier Detection Result
+     * @param {ComputationApiOutlierDetectionResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApiInterface
+     */
+    outlierDetectionResult(requestParameters: ComputationApiOutlierDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResult>;
     /**
      * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
      * @summary Get a single execution result\'s metadata.
@@ -4522,6 +4786,62 @@ export interface ComputationApiKeyDriverAnalysisResultRequest {
      */
     readonly limit?: number;
 }
+/**
+ * Request parameters for outlierDetection operation in ComputationApi.
+ * @export
+ * @interface ComputationApiOutlierDetectionRequest
+ */
+export interface ComputationApiOutlierDetectionRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComputationApiOutlierDetection
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {OutlierDetectionRequest}
+     * @memberof ComputationApiOutlierDetection
+     */
+    readonly outlierDetectionRequest: OutlierDetectionRequest;
+    /**
+     * Ignore all caches during execution of current request.
+     * @type {boolean}
+     * @memberof ComputationApiOutlierDetection
+     */
+    readonly skipCache?: boolean;
+}
+/**
+ * Request parameters for outlierDetectionResult operation in ComputationApi.
+ * @export
+ * @interface ComputationApiOutlierDetectionResultRequest
+ */
+export interface ComputationApiOutlierDetectionResultRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComputationApiOutlierDetectionResult
+     */
+    readonly workspaceId: string;
+    /**
+     * Result ID
+     * @type {string}
+     * @memberof ComputationApiOutlierDetectionResult
+     */
+    readonly resultId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ComputationApiOutlierDetectionResult
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ComputationApiOutlierDetectionResult
+     */
+    readonly limit?: number;
+}
 /**
  * Request parameters for retrieveExecutionMetadata operation in ComputationApi.
  * @export
@@ -4672,6 +4992,24 @@ export declare class ComputationApi extends BaseAPI implements ComputationApiInt
      * @memberof ComputationApi
      */
     keyDriverAnalysisResult(requestParameters: ComputationApiKeyDriverAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<KeyDriversResult>;
+    /**
+     * (BETA) Computes outlier detection for the provided execution definition.
+     * @summary (BETA) Outlier Detection
+     * @param {ComputationApiOutlierDetectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    outlierDetection(requestParameters: ComputationApiOutlierDetectionRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResponse>;
+    /**
+     * (BETA) Gets outlier detection result.
+     * @summary (BETA) Outlier Detection Result
+     * @param {ComputationApiOutlierDetectionResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    outlierDetectionResult(requestParameters: ComputationApiOutlierDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise<OutlierDetectionResult>;
     /**
      * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
      * @summary Get a single execution result\'s metadata.