Interface AutomlPredictionsAPI

interface AutomlPredictionsAPI {
    clearCache: () => void;
    createAutomlPredictionJob: (
        predictionId: string,
        options?: ApiCallOptions,
    ) => Promise<CreateAutomlPredictionJobHttpResponse>;
    getAutomlPredictionCoordinateShap: (
        predictionId: string,
        query: { refId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAutomlPredictionCoordinateShapHttpResponse>;
    getAutomlPredictionNotPredictedReasons: (
        predictionId: string,
        query: { refId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAutomlPredictionNotPredictedReasonsHttpResponse>;
    getAutomlPredictionPredictions: (
        predictionId: string,
        query: { refId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAutomlPredictionPredictionsHttpResponse>;
    getAutomlPredictionShap: (
        predictionId: string,
        query: { refId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAutomlPredictionShapHttpResponse>;
    getAutomlPredictionSource: (
        predictionId: string,
        query: { refId?: string },
        options?: ApiCallOptions,
    ) => Promise<GetAutomlPredictionSourceHttpResponse>;
}
Index

Properties

clearCache createAutomlPredictionJob getAutomlPredictionCoordinateShap getAutomlPredictionNotPredictedReasons getAutomlPredictionPredictions getAutomlPredictionShap getAutomlPredictionSource

Properties

clearCache: () => void

Clears the cache for automl-predictions api requests.

Type Declaration

    • (): void

    • Clears the cache for automl-predictions api requests.

      Returns void

createAutomlPredictionJob: (
    predictionId: string,
    options?: ApiCallOptions,
) => Promise<CreateAutomlPredictionJobHttpResponse>

Type Declaration

Retrieve jobs that are associated with a prediction. Job with correlation type prediction.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

CreateAutomlPredictionJobHttpError

getAutomlPredictionCoordinateShap: (
    predictionId: string,
    query: { refId?: string },
    options?: ApiCallOptions,
) => Promise<GetAutomlPredictionCoordinateShapHttpResponse>

Type Declaration

    • (
          predictionId: string,
          query: { refId?: string },
          options?: ApiCallOptions,
      ): Promise<GetAutomlPredictionCoordinateShapHttpResponse>

    • Parameters

      • predictionId: string

        The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

      • query: { refId?: string }

        an object with query parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAutomlPredictionCoordinateShapHttpResponse>

      Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.

      GetAutomlPredictionCoordinateShapHttpError

Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

an object with query parameters

GetAutomlPredictionCoordinateShapHttpError

getAutomlPredictionNotPredictedReasons: (
    predictionId: string,
    query: { refId?: string },
    options?: ApiCallOptions,
) => Promise<GetAutomlPredictionNotPredictedReasonsHttpResponse>

Type Declaration

Returns a file containing any rows in a prediction operation where a prediction was unable to be produced.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

an object with query parameters

GetAutomlPredictionNotPredictedReasonsHttpError

getAutomlPredictionPredictions: (
    predictionId: string,
    query: { refId?: string },
    options?: ApiCallOptions,
) => Promise<GetAutomlPredictionPredictionsHttpResponse>

Type Declaration

    • (
          predictionId: string,
          query: { refId?: string },
          options?: ApiCallOptions,
      ): Promise<GetAutomlPredictionPredictionsHttpResponse>

    • Parameters

      • predictionId: string

        The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

      • query: { refId?: string }

        an object with query parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAutomlPredictionPredictionsHttpResponse>

      Returns a file containing the predicted values that are associated with a prediction ID.

      GetAutomlPredictionPredictionsHttpError

Returns a file containing the predicted values that are associated with a prediction ID.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

an object with query parameters

GetAutomlPredictionPredictionsHttpError

getAutomlPredictionShap: (
    predictionId: string,
    query: { refId?: string },
    options?: ApiCallOptions,
) => Promise<GetAutomlPredictionShapHttpResponse>

Type Declaration

    • (
          predictionId: string,
          query: { refId?: string },
          options?: ApiCallOptions,
      ): Promise<GetAutomlPredictionShapHttpResponse>

    • Parameters

      • predictionId: string

        The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

      • query: { refId?: string }

        an object with query parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAutomlPredictionShapHttpResponse>

      Returns a file containing the shapley values that are associated with a prediction ID.

      GetAutomlPredictionShapHttpError

Returns a file containing the shapley values that are associated with a prediction ID.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

an object with query parameters

GetAutomlPredictionShapHttpError

getAutomlPredictionSource: (
    predictionId: string,
    query: { refId?: string },
    options?: ApiCallOptions,
) => Promise<GetAutomlPredictionSourceHttpResponse>

Type Declaration

    • (
          predictionId: string,
          query: { refId?: string },
          options?: ApiCallOptions,
      ): Promise<GetAutomlPredictionSourceHttpResponse>

    • Parameters

      • predictionId: string

        The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

      • query: { refId?: string }

        an object with query parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAutomlPredictionSourceHttpResponse>

      Returns a file containing the source values and an index field that are associated with a prediction ID.

      GetAutomlPredictionSourceHttpError

Returns a file containing the source values and an index field that are associated with a prediction ID.

The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

an object with query parameters

GetAutomlPredictionSourceHttpError

Settings

Member Visibility

On This Page

Properties