Interface AutomlDeploymentsAPI

interface AutomlDeploymentsAPI {
    clearCache: () => void;
    createAutomlDeploymentRealtimePrediction: (
        deploymentId: string,
        query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        },
        body: RealtimePredictionInput,
        options?: ApiCallOptions,
    ) => Promise<CreateAutomlDeploymentRealtimePredictionHttpResponse>;
}
Index

Properties

clearCache createAutomlDeploymentRealtimePrediction

Properties

clearCache: () => void

Clears the cache for automl-deployments api requests.

Type declaration

    • (): void

    • Clears the cache for automl-deployments api requests.

      Returns void

createAutomlDeploymentRealtimePrediction: (
    deploymentId: string,
    query: {
        includeNotPredictedReason?: boolean;
        includeShap?: boolean;
        includeSource?: boolean;
        index?: string;
    },
    body: RealtimePredictionInput,
    options?: ApiCallOptions,
) => Promise<CreateAutomlDeploymentRealtimePredictionHttpResponse>

Generates predictions in a synchronous request and response.

Type declaration

    • (
          deploymentId: string,
          query: {
              includeNotPredictedReason?: boolean;
              includeShap?: boolean;
              includeSource?: boolean;
              index?: string;
          },
          body: RealtimePredictionInput,
          options?: ApiCallOptions,
      ): Promise<CreateAutomlDeploymentRealtimePredictionHttpResponse>

    • Generates predictions in a synchronous request and response.

      Parameters

      • deploymentId: string

        The ID of the ML deployed model that will be employed to produce predictions.

      • query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        }

        an object with query parameters

        • OptionalincludeNotPredictedReason?: boolean

          If true, will include a column with the reason why a prediction was not produced.

        • OptionalincludeShap?: boolean

          If true, the shapley values will be included in the response.

        • OptionalincludeSource?: boolean

          If true, the source data will be included in the response

        • Optionalindex?: string

          The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

      • body: RealtimePredictionInput

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<CreateAutomlDeploymentRealtimePredictionHttpResponse>

      CreateAutomlDeploymentRealtimePredictionHttpError

The ID of the ML deployed model that will be employed to produce predictions.

an object with query parameters

Param: body

an object with the body content

CreateAutomlDeploymentRealtimePredictionHttpError

Settings

Member Visibility

On This Page

Properties