AI-based Optimizer API documentation version v1

http://server:port/activeviam/ai-optimizer/rest/v1

Home

This document describes the REST API of AI-based Optimizer.

Note: the root URL provided here will depend of the deployment of your application.

/aggregate-provider

API to access the partial aggregate provider AI recommendation service.

get

get

Retrieve the size of the query history for each cube.

delete

delete

Delete the query history on which the aggregate provider recommendations are based for each cube.

delete

delete

Delete the query history on which the aggregate provider recommendations are based for the given cube.

Delete the query history on which the aggregate provider recommendations are based for the given cube.

Path Parameters

  • pivotId: required (string)

    Name of the ActivePivot instance for which the history deletion is performed.

post

post

Computes the partial aggregate providers needed to efficiently cover the query history.

Partial aggregate providers are recommended for every data cube.

This endpoint is intended to be called in a test environment, in order not to impact the production environment.

Computes the partial aggregate providers needed to efficiently cover the query history.

Partial aggregate providers are recommended for every data cube.

This endpoint is intended to be called in a test environment, in order not to impact the production environment.

Query Parameters

  • coverTarget: required (number)

    Number between 0 and 1 that represents the percentage of the query history to be covered. If it is less than 1, the query optimizer automatically selects which queries to cover by eliminating those that contribute the least to the overall performance of the recommendations.

HTTP status code 200

Pieces of java code to configure the resulting partial aggregate providers.

post

post

Computes the partial aggregate providers needed to efficiently cover the query history for the given cube.

This endpoint is intended to be called in a test environment, in order not to impact the production environment.

Computes the partial aggregate providers needed to efficiently cover the query history for the given cube.

This endpoint is intended to be called in a test environment, in order not to impact the production environment.

Path Parameters

  • pivotId: required (string)

    Name of the ActivePivot instance for which the recommendations are computed.

Query Parameters

  • coverTarget: required (number)

    Number between 0 and 1 that represents the percentage of the query history to be covered. If it is less than 1, the query optimizer automatically selects which queries to cover by eliminating those that contribute the least to the overall performance of the recommendations.

HTTP status code 200

Pieces of java code to configure the resulting partial aggregate providers.