@azure-rest/ai-anomaly-detector 1.0.0-beta.1 → 1.0.0-beta.2

package/dist/esm/outputModels.d.ts

@@ -0,0 +1,367 @@
+/** The response of entire anomaly detection. */
+export interface UnivariateEntireDetectionResultOutput {
+    /**
+     * Frequency extracted from the series, zero means no recurrent pattern has been
+     * found.
+     */
+    period: number;
+    /**
+     * ExpectedValues contain expected value for each input point. The index of the
+     * array is consistent with the input series.
+     */
+    expectedValues: number[];
+    /**
+     * UpperMargins contain upper margin of each input point. UpperMargin is used to
+     * calculate upperBoundary, which equals to expectedValue + (100 -
+     * marginScale)*upperMargin. Anomalies in response can be filtered by
+     * upperBoundary and lowerBoundary. By adjusting marginScale value, less
+     * significant anomalies can be filtered in client side. The index of the array is
+     * consistent with the input series.
+     */
+    upperMargins: number[];
+    /**
+     * LowerMargins contain lower margin of each input point. LowerMargin is used to
+     * calculate lowerBoundary, which equals to expectedValue - (100 -
+     * marginScale)*lowerMargin. Points between the boundary can be marked as normal
+     * ones in client side. The index of the array is consistent with the input
+     * series.
+     */
+    lowerMargins: number[];
+    /**
+     * IsAnomaly contains anomaly properties for each input point. True means an
+     * anomaly either negative or positive has been detected. The index of the array
+     * is consistent with the input series.
+     */
+    isAnomaly: boolean[];
+    /**
+     * IsNegativeAnomaly contains anomaly status in negative direction for each input
+     * point. True means a negative anomaly has been detected. A negative anomaly
+     * means the point is detected as an anomaly and its real value is smaller than
+     * the expected one. The index of the array is consistent with the input series.
+     */
+    isNegativeAnomaly: boolean[];
+    /**
+     * IsPositiveAnomaly contain anomaly status in positive direction for each input
+     * point. True means a positive anomaly has been detected. A positive anomaly
+     * means the point is detected as an anomaly and its real value is larger than the
+     * expected one. The index of the array is consistent with the input series.
+     */
+    isPositiveAnomaly: boolean[];
+    /**
+     * The severity score for each input point. The larger the value is, the more
+     * sever the anomaly is. For normal points, the "severity" is always 0.
+     */
+    severity?: number[];
+}
+/** Error information returned by the API. */
+export interface AnomalyDetectorErrorOutput {
+    /**
+     * The error code.
+     *
+     * Possible values: InvalidCustomInterval, BadArgument, InvalidGranularity, InvalidPeriod, InvalidModelArgument, InvalidSeries, InvalidJsonFormat, RequiredGranularity, RequiredSeries, InvalidImputeMode, InvalidImputeFixedValue
+     */
+    code?: string;
+    /** A message explaining the error reported by the service. */
+    message?: string;
+}
+/** The response of last anomaly detection. */
+export interface UnivariateLastDetectionResultOutput {
+    /**
+     * Frequency extracted from the series, zero means no recurrent pattern has been
+     * found.
+     */
+    period: number;
+    /** Suggested input series points needed for detecting the latest point. */
+    suggestedWindow: number;
+    /** Expected value of the latest point. */
+    expectedValue: number;
+    /**
+     * Upper margin of the latest point. UpperMargin is used to calculate
+     * upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin.
+     * If the value of latest point is between upperBoundary and lowerBoundary, it
+     * should be treated as normal value. By adjusting marginScale value, anomaly
+     * status of latest point can be changed.
+     */
+    upperMargin: number;
+    /**
+     * Lower margin of the latest point. LowerMargin is used to calculate
+     * lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.
+     *
+     */
+    lowerMargin: number;
+    /**
+     * Anomaly status of the latest point, true means the latest point is an anomaly
+     * either in negative direction or positive direction.
+     */
+    isAnomaly: boolean;
+    /**
+     * Anomaly status in negative direction of the latest point. True means the latest
+     * point is an anomaly and its real value is smaller than the expected one.
+     */
+    isNegativeAnomaly: boolean;
+    /**
+     * Anomaly status in positive direction of the latest point. True means the latest
+     * point is an anomaly and its real value is larger than the expected one.
+     */
+    isPositiveAnomaly: boolean;
+    /**
+     * The severity score for the last input point. The larger the value is, the more
+     * sever the anomaly is. For normal points, the "severity" is always 0.
+     */
+    severity?: number;
+}
+/** The response of change point detection. */
+export interface UnivariateChangePointDetectionResultOutput {
+    /**
+     * Frequency extracted from the series, zero means no recurrent pattern has been
+     * found.
+     */
+    readonly period?: number;
+    /**
+     * isChangePoint contains change point properties for each input point. True means
+     * an anomaly either negative or positive has been detected. The index of the
+     * array is consistent with the input series.
+     */
+    isChangePoint?: boolean[];
+    /** the change point confidence of each point */
+    confidenceScores?: number[];
+}
+/** Detection results for the given resultId. */
+export interface MultivariateDetectionResultOutput {
+    /** Result identifier, which is used to fetch the results of an inference call. */
+    resultId: string;
+    /** Multivariate anomaly detection status. */
+    summary: MultivariateBatchDetectionResultSummaryOutput;
+    /** Detection result for each timestamp. */
+    results: Array<AnomalyStateOutput>;
+}
+/** Multivariate anomaly detection status. */
+export interface MultivariateBatchDetectionResultSummaryOutput {
+    /** Status of detection results. One of CREATED, RUNNING, READY, and FAILED. */
+    status: "CREATED" | "RUNNING" | "READY" | "FAILED";
+    /** Error message when detection is failed. */
+    errors?: Array<ErrorResponseOutput>;
+    /** Variable Status. */
+    variableStates?: Array<VariableStateOutput>;
+    /**
+     * Detection request for batch inference. This is an asynchronous inference which
+     * will need another API to get detection results.
+     */
+    setupInfo: MultivariateBatchDetectionOptionsOutput;
+}
+/** ErrorResponse contains code and message that shows the error information. */
+export interface ErrorResponseOutput {
+    /** The error code. */
+    code: string;
+    /** The message explaining the error reported by the service. */
+    message: string;
+}
+/** Variable Status. */
+export interface VariableStateOutput {
+    /** Variable name in variable states. */
+    variable?: string;
+    /** Proportion of missing values that need to be filled by fillNAMethod. */
+    filledNARatio?: number;
+    /** Number of effective data points before applying fillNAMethod. */
+    effectiveCount?: number;
+    /** First valid timestamp with value of input data. */
+    firstTimestamp?: string;
+    /** Last valid timestamp with value of input data. */
+    lastTimestamp?: string;
+}
+/**
+ * Detection request for batch inference. This is an asynchronous inference which
+ * will need another API to get detection results.
+ */
+export interface MultivariateBatchDetectionOptionsOutput {
+    /**
+     * Source link to the input data to indicate an accessible Azure storage Uri,
+     * either pointed to an Azure blob storage folder, or pointed to a CSV file in
+     * Azure blob storage based on you data schema selection. The data schema should
+     * be exactly the same with those used in the training phase.
+     */
+    dataSource: string;
+    /**
+     * An optional field, which is used to specify the number of top contributed
+     * variables for one anomalous timestamp in the response. The default number is
+     * 10.
+     */
+    topContributorCount: number;
+    /**
+     * A required field, indicating the start time of data for detection, which should
+     * be date-time of ISO 8601 format.
+     */
+    startTime: string;
+    /**
+     * A required field, indicating the end time of data for detection, which should
+     * be date-time of ISO 8601 format.
+     */
+    endTime: string;
+}
+/** Anomaly status and information. */
+export interface AnomalyStateOutput {
+    /** The timestamp for this anomaly. */
+    timestamp: string;
+    /** The detailed value of this anomalous timestamp. */
+    value?: AnomalyValueOutput;
+    /** Error message for the current timestamp. */
+    errors?: Array<ErrorResponseOutput>;
+}
+/** Detailed information of the anomalous timestamp. */
+export interface AnomalyValueOutput {
+    /** True if an anomaly is detected at the current timestamp. */
+    isAnomaly: boolean;
+    /**
+     * Indicates the significance of the anomaly. The higher the severity, the more
+     * significant the anomaly is.
+     */
+    severity: number;
+    /**
+     * Raw anomaly score of severity, will help indicate the degree of abnormality as
+     * well.
+     */
+    score: number;
+    /** Interpretation of this anomalous timestamp. */
+    interpretation?: Array<AnomalyInterpretationOutput>;
+}
+/** Interpretation of the anomalous timestamp. */
+export interface AnomalyInterpretationOutput {
+    /** Variable. */
+    variable?: string;
+    /**
+     * This score shows the percentage contributing to the anomalous timestamp. A
+     * number between 0 and 1.
+     */
+    contributionScore?: number;
+    /** Correlation changes among the anomalous variables */
+    correlationChanges?: CorrelationChangesOutput;
+}
+/** Correlation changes among the anomalous variables */
+export interface CorrelationChangesOutput {
+    /** The correlated variables that have correlation changes under an anomaly. */
+    changedVariables?: string[];
+}
+/**
+ * Training result of a model including its status, errors and diagnostics
+ * information.
+ */
+export interface ModelInfoOutput {
+    /**
+     * Source link to the input data to indicate an accessible Azure storage Uri,
+     * either pointed to an Azure blob storage folder, or pointed to a CSV file in
+     * Azure blob storage based on you data schema selection.
+     */
+    dataSource: string;
+    /**
+     * Data schema of input data source: OneTable or MultiTable. The default
+     * DataSchema is OneTable.
+     *
+     * Possible values: OneTable, MultiTable
+     */
+    dataSchema?: string;
+    /**
+     * A required field, indicating the start time of training data, which should be
+     * date-time of ISO 8601 format.
+     */
+    startTime: string;
+    /**
+     * A required field, indicating the end time of training data, which should be
+     * date-time of ISO 8601 format.
+     */
+    endTime: string;
+    /**
+     * An optional field. The display name of the model whose maximum length is 24
+     * characters.
+     */
+    displayName?: string;
+    /**
+     * An optional field, indicating how many previous timestamps will be used to
+     * detect whether the timestamp is anomaly or not.
+     */
+    slidingWindow?: number;
+    /** An optional field, indicating the manner to align multiple variables. */
+    alignPolicy?: AlignPolicyOutput;
+    /** Model status. One of CREATED, RUNNING, READY, and FAILED. */
+    status?: "CREATED" | "RUNNING" | "READY" | "FAILED";
+    /** Error messages when failed to create a model. */
+    readonly errors?: Array<ErrorResponseOutput>;
+    /** Diagnostics information to help inspect the states of model or variable. */
+    diagnosticsInfo?: DiagnosticsInfoOutput;
+}
+/** An optional field, indicating the manner to align multiple variables. */
+export interface AlignPolicyOutput {
+    /**
+     * An optional field, indicating how to align different variables to the same
+     * time-range. Either Inner or Outer.
+     */
+    alignMode?: "Inner" | "Outer";
+    /**
+     * An optional field, indicating how missing values will be filled. One of
+     * Previous, Subsequent, Linear, Zero, Fixed.
+     *
+     * Possible values: Previous, Subsequent, Linear, Zero, Fixed
+     */
+    fillNAMethod?: string;
+    /** An optional field. Required when fillNAMethod is Fixed. */
+    paddingValue?: number;
+}
+/** Diagnostics information to help inspect the states of model or variable. */
+export interface DiagnosticsInfoOutput {
+    /** Model status. */
+    modelState?: ModelStateOutput;
+    /** Variable Status. */
+    variableStates?: Array<VariableStateOutput>;
+}
+/** Model status. */
+export interface ModelStateOutput {
+    /**
+     * This indicates the number of passes of the entire training dataset the
+     * algorithm has completed.
+     */
+    epochIds?: number[];
+    /**
+     * List of metrics used to assess how the model fits the training data for each
+     * epoch.
+     */
+    trainLosses?: number[];
+    /**
+     * List of metrics used to assess how the model fits the validation set for each
+     * epoch.
+     */
+    validationLosses?: number[];
+    /** Latency for each epoch. */
+    latenciesInSeconds?: number[];
+}
+/** Response of getting a model. */
+export interface AnomalyDetectionModelOutput {
+    /** Model identifier. */
+    modelId: string;
+    /** Date and time (UTC) when the model was created. */
+    createdTime: string;
+    /** Date and time (UTC) when the model was last updated. */
+    lastUpdatedTime: string;
+    /**
+     * Training result of a model including its status, errors and diagnostics
+     * information.
+     */
+    modelInfo?: ModelInfoOutput;
+}
+/** Response of listing models. */
+export interface ModelListOutput {
+    /** List of models. */
+    models: Array<AnomalyDetectionModelOutput>;
+    /** Number of trained multivariate models. */
+    currentCount: number;
+    /** Maximum number of models that can be trained for this Anomaly Detector resource. */
+    maxCount: number;
+    /** The link to fetch more models. */
+    nextLink?: string;
+}
+/** Results of last detection. */
+export interface MultivariateLastDetectionResultOutput {
+    /** Variable Status. */
+    variableStates?: Array<VariableStateOutput>;
+    /** Anomaly status and information. */
+    results?: Array<AnomalyStateOutput>;
+}
+//# sourceMappingURL=outputModels.d.ts.map

package/dist/esm/outputModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,gDAAgD;AAChD,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB;;;;;OAKG;IACH,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAC7B;;;;;OAKG;IACH,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,6CAA6C;AAC7C,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,8CAA8C;AAC9C,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAC;IACxB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,8CAA8C;AAC9C,MAAM,WAAW,0CAA0C;IACzD;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;IAC1B,gDAAgD;IAChD,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,gDAAgD;AAChD,MAAM,WAAW,iCAAiC;IAChD,kFAAkF;IAClF,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,OAAO,EAAE,6CAA6C,CAAC;IACvD,2CAA2C;IAC3C,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACpC;AAED,6CAA6C;AAC7C,MAAM,WAAW,6CAA6C;IAC5D,+EAA+E;IAC/E,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IACnD,8CAA8C;IAC9C,MAAM,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACpC,uBAAuB;IACvB,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5C;;;OAGG;IACH,SAAS,EAAE,uCAAuC,CAAC;CACpD;AAED,gFAAgF;AAChF,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uBAAuB;AACvB,MAAM,WAAW,mBAAmB;IAClC,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oEAAoE;IACpE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACrC;AAED,uDAAuD;AACvD,MAAM,WAAW,kBAAkB;IACjC,+DAA+D;IAC/D,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,cAAc,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;CACrD;AAED,iDAAiD;AACjD,MAAM,WAAW,2BAA2B;IAC1C,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,wBAAwB,CAAC;CAC/C;AAED,wDAAwD;AACxD,MAAM,WAAW,wBAAwB;IACvC,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4EAA4E;IAC5E,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,gEAAgE;IAChE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,oDAAoD;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC7C,+EAA+E;IAC/E,eAAe,CAAC,EAAE,qBAAqB,CAAC;CACzC;AAED,4EAA4E;AAC5E,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,qBAAqB;IACpC,oBAAoB;IACpB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,uBAAuB;IACvB,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED,oBAAoB;AACpB,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,8BAA8B;IAC9B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,mCAAmC;AACnC,MAAM,WAAW,2BAA2B;IAC1C,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED,kCAAkC;AAClC,MAAM,WAAW,eAAe;IAC9B,sBAAsB;IACtB,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC3C,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,uFAAuF;IACvF,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,iCAAiC;AACjC,MAAM,WAAW,qCAAqC;IACpD,uBAAuB;IACvB,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5C,sCAAsC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACrC"}

package/dist/esm/outputModels.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=outputModels.js.map

package/dist/esm/outputModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** The response of entire anomaly detection. */\nexport interface UnivariateEntireDetectionResultOutput {\n  /**\n   * Frequency extracted from the series, zero means no recurrent pattern has been\n   * found.\n   */\n  period: number;\n  /**\n   * ExpectedValues contain expected value for each input point. The index of the\n   * array is consistent with the input series.\n   */\n  expectedValues: number[];\n  /**\n   * UpperMargins contain upper margin of each input point. UpperMargin is used to\n   * calculate upperBoundary, which equals to expectedValue + (100 -\n   * marginScale)*upperMargin. Anomalies in response can be filtered by\n   * upperBoundary and lowerBoundary. By adjusting marginScale value, less\n   * significant anomalies can be filtered in client side. The index of the array is\n   * consistent with the input series.\n   */\n  upperMargins: number[];\n  /**\n   * LowerMargins contain lower margin of each input point. LowerMargin is used to\n   * calculate lowerBoundary, which equals to expectedValue - (100 -\n   * marginScale)*lowerMargin. Points between the boundary can be marked as normal\n   * ones in client side. The index of the array is consistent with the input\n   * series.\n   */\n  lowerMargins: number[];\n  /**\n   * IsAnomaly contains anomaly properties for each input point. True means an\n   * anomaly either negative or positive has been detected. The index of the array\n   * is consistent with the input series.\n   */\n  isAnomaly: boolean[];\n  /**\n   * IsNegativeAnomaly contains anomaly status in negative direction for each input\n   * point. True means a negative anomaly has been detected. A negative anomaly\n   * means the point is detected as an anomaly and its real value is smaller than\n   * the expected one. The index of the array is consistent with the input series.\n   */\n  isNegativeAnomaly: boolean[];\n  /**\n   * IsPositiveAnomaly contain anomaly status in positive direction for each input\n   * point. True means a positive anomaly has been detected. A positive anomaly\n   * means the point is detected as an anomaly and its real value is larger than the\n   * expected one. The index of the array is consistent with the input series.\n   */\n  isPositiveAnomaly: boolean[];\n  /**\n   * The severity score for each input point. The larger the value is, the more\n   * sever the anomaly is. For normal points, the \"severity\" is always 0.\n   */\n  severity?: number[];\n}\n\n/** Error information returned by the API. */\nexport interface AnomalyDetectorErrorOutput {\n  /**\n   * The error code.\n   *\n   * Possible values: InvalidCustomInterval, BadArgument, InvalidGranularity, InvalidPeriod, InvalidModelArgument, InvalidSeries, InvalidJsonFormat, RequiredGranularity, RequiredSeries, InvalidImputeMode, InvalidImputeFixedValue\n   */\n  code?: string;\n  /** A message explaining the error reported by the service. */\n  message?: string;\n}\n\n/** The response of last anomaly detection. */\nexport interface UnivariateLastDetectionResultOutput {\n  /**\n   * Frequency extracted from the series, zero means no recurrent pattern has been\n   * found.\n   */\n  period: number;\n  /** Suggested input series points needed for detecting the latest point. */\n  suggestedWindow: number;\n  /** Expected value of the latest point. */\n  expectedValue: number;\n  /**\n   * Upper margin of the latest point. UpperMargin is used to calculate\n   * upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin.\n   * If the value of latest point is between upperBoundary and lowerBoundary, it\n   * should be treated as normal value. By adjusting marginScale value, anomaly\n   * status of latest point can be changed.\n   */\n  upperMargin: number;\n  /**\n   * Lower margin of the latest point. LowerMargin is used to calculate\n   * lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.\n   *\n   */\n  lowerMargin: number;\n  /**\n   * Anomaly status of the latest point, true means the latest point is an anomaly\n   * either in negative direction or positive direction.\n   */\n  isAnomaly: boolean;\n  /**\n   * Anomaly status in negative direction of the latest point. True means the latest\n   * point is an anomaly and its real value is smaller than the expected one.\n   */\n  isNegativeAnomaly: boolean;\n  /**\n   * Anomaly status in positive direction of the latest point. True means the latest\n   * point is an anomaly and its real value is larger than the expected one.\n   */\n  isPositiveAnomaly: boolean;\n  /**\n   * The severity score for the last input point. The larger the value is, the more\n   * sever the anomaly is. For normal points, the \"severity\" is always 0.\n   */\n  severity?: number;\n}\n\n/** The response of change point detection. */\nexport interface UnivariateChangePointDetectionResultOutput {\n  /**\n   * Frequency extracted from the series, zero means no recurrent pattern has been\n   * found.\n   */\n  readonly period?: number;\n  /**\n   * isChangePoint contains change point properties for each input point. True means\n   * an anomaly either negative or positive has been detected. The index of the\n   * array is consistent with the input series.\n   */\n  isChangePoint?: boolean[];\n  /** the change point confidence of each point */\n  confidenceScores?: number[];\n}\n\n/** Detection results for the given resultId. */\nexport interface MultivariateDetectionResultOutput {\n  /** Result identifier, which is used to fetch the results of an inference call. */\n  resultId: string;\n  /** Multivariate anomaly detection status. */\n  summary: MultivariateBatchDetectionResultSummaryOutput;\n  /** Detection result for each timestamp. */\n  results: Array<AnomalyStateOutput>;\n}\n\n/** Multivariate anomaly detection status. */\nexport interface MultivariateBatchDetectionResultSummaryOutput {\n  /** Status of detection results. One of CREATED, RUNNING, READY, and FAILED. */\n  status: \"CREATED\" | \"RUNNING\" | \"READY\" | \"FAILED\";\n  /** Error message when detection is failed. */\n  errors?: Array<ErrorResponseOutput>;\n  /** Variable Status. */\n  variableStates?: Array<VariableStateOutput>;\n  /**\n   * Detection request for batch inference. This is an asynchronous inference which\n   * will need another API to get detection results.\n   */\n  setupInfo: MultivariateBatchDetectionOptionsOutput;\n}\n\n/** ErrorResponse contains code and message that shows the error information. */\nexport interface ErrorResponseOutput {\n  /** The error code. */\n  code: string;\n  /** The message explaining the error reported by the service. */\n  message: string;\n}\n\n/** Variable Status. */\nexport interface VariableStateOutput {\n  /** Variable name in variable states. */\n  variable?: string;\n  /** Proportion of missing values that need to be filled by fillNAMethod. */\n  filledNARatio?: number;\n  /** Number of effective data points before applying fillNAMethod. */\n  effectiveCount?: number;\n  /** First valid timestamp with value of input data. */\n  firstTimestamp?: string;\n  /** Last valid timestamp with value of input data. */\n  lastTimestamp?: string;\n}\n\n/**\n * Detection request for batch inference. This is an asynchronous inference which\n * will need another API to get detection results.\n */\nexport interface MultivariateBatchDetectionOptionsOutput {\n  /**\n   * Source link to the input data to indicate an accessible Azure storage Uri,\n   * either pointed to an Azure blob storage folder, or pointed to a CSV file in\n   * Azure blob storage based on you data schema selection. The data schema should\n   * be exactly the same with those used in the training phase.\n   */\n  dataSource: string;\n  /**\n   * An optional field, which is used to specify the number of top contributed\n   * variables for one anomalous timestamp in the response. The default number is\n   * 10.\n   */\n  topContributorCount: number;\n  /**\n   * A required field, indicating the start time of data for detection, which should\n   * be date-time of ISO 8601 format.\n   */\n  startTime: string;\n  /**\n   * A required field, indicating the end time of data for detection, which should\n   * be date-time of ISO 8601 format.\n   */\n  endTime: string;\n}\n\n/** Anomaly status and information. */\nexport interface AnomalyStateOutput {\n  /** The timestamp for this anomaly. */\n  timestamp: string;\n  /** The detailed value of this anomalous timestamp. */\n  value?: AnomalyValueOutput;\n  /** Error message for the current timestamp. */\n  errors?: Array<ErrorResponseOutput>;\n}\n\n/** Detailed information of the anomalous timestamp. */\nexport interface AnomalyValueOutput {\n  /** True if an anomaly is detected at the current timestamp. */\n  isAnomaly: boolean;\n  /**\n   * Indicates the significance of the anomaly. The higher the severity, the more\n   * significant the anomaly is.\n   */\n  severity: number;\n  /**\n   * Raw anomaly score of severity, will help indicate the degree of abnormality as\n   * well.\n   */\n  score: number;\n  /** Interpretation of this anomalous timestamp. */\n  interpretation?: Array<AnomalyInterpretationOutput>;\n}\n\n/** Interpretation of the anomalous timestamp. */\nexport interface AnomalyInterpretationOutput {\n  /** Variable. */\n  variable?: string;\n  /**\n   * This score shows the percentage contributing to the anomalous timestamp. A\n   * number between 0 and 1.\n   */\n  contributionScore?: number;\n  /** Correlation changes among the anomalous variables */\n  correlationChanges?: CorrelationChangesOutput;\n}\n\n/** Correlation changes among the anomalous variables */\nexport interface CorrelationChangesOutput {\n  /** The correlated variables that have correlation changes under an anomaly. */\n  changedVariables?: string[];\n}\n\n/**\n * Training result of a model including its status, errors and diagnostics\n * information.\n */\nexport interface ModelInfoOutput {\n  /**\n   * Source link to the input data to indicate an accessible Azure storage Uri,\n   * either pointed to an Azure blob storage folder, or pointed to a CSV file in\n   * Azure blob storage based on you data schema selection.\n   */\n  dataSource: string;\n  /**\n   * Data schema of input data source: OneTable or MultiTable. The default\n   * DataSchema is OneTable.\n   *\n   * Possible values: OneTable, MultiTable\n   */\n  dataSchema?: string;\n  /**\n   * A required field, indicating the start time of training data, which should be\n   * date-time of ISO 8601 format.\n   */\n  startTime: string;\n  /**\n   * A required field, indicating the end time of training data, which should be\n   * date-time of ISO 8601 format.\n   */\n  endTime: string;\n  /**\n   * An optional field. The display name of the model whose maximum length is 24\n   * characters.\n   */\n  displayName?: string;\n  /**\n   * An optional field, indicating how many previous timestamps will be used to\n   * detect whether the timestamp is anomaly or not.\n   */\n  slidingWindow?: number;\n  /** An optional field, indicating the manner to align multiple variables. */\n  alignPolicy?: AlignPolicyOutput;\n  /** Model status. One of CREATED, RUNNING, READY, and FAILED. */\n  status?: \"CREATED\" | \"RUNNING\" | \"READY\" | \"FAILED\";\n  /** Error messages when failed to create a model. */\n  readonly errors?: Array<ErrorResponseOutput>;\n  /** Diagnostics information to help inspect the states of model or variable. */\n  diagnosticsInfo?: DiagnosticsInfoOutput;\n}\n\n/** An optional field, indicating the manner to align multiple variables. */\nexport interface AlignPolicyOutput {\n  /**\n   * An optional field, indicating how to align different variables to the same\n   * time-range. Either Inner or Outer.\n   */\n  alignMode?: \"Inner\" | \"Outer\";\n  /**\n   * An optional field, indicating how missing values will be filled. One of\n   * Previous, Subsequent, Linear, Zero, Fixed.\n   *\n   * Possible values: Previous, Subsequent, Linear, Zero, Fixed\n   */\n  fillNAMethod?: string;\n  /** An optional field. Required when fillNAMethod is Fixed. */\n  paddingValue?: number;\n}\n\n/** Diagnostics information to help inspect the states of model or variable. */\nexport interface DiagnosticsInfoOutput {\n  /** Model status. */\n  modelState?: ModelStateOutput;\n  /** Variable Status. */\n  variableStates?: Array<VariableStateOutput>;\n}\n\n/** Model status. */\nexport interface ModelStateOutput {\n  /**\n   * This indicates the number of passes of the entire training dataset the\n   * algorithm has completed.\n   */\n  epochIds?: number[];\n  /**\n   * List of metrics used to assess how the model fits the training data for each\n   * epoch.\n   */\n  trainLosses?: number[];\n  /**\n   * List of metrics used to assess how the model fits the validation set for each\n   * epoch.\n   */\n  validationLosses?: number[];\n  /** Latency for each epoch. */\n  latenciesInSeconds?: number[];\n}\n\n/** Response of getting a model. */\nexport interface AnomalyDetectionModelOutput {\n  /** Model identifier. */\n  modelId: string;\n  /** Date and time (UTC) when the model was created. */\n  createdTime: string;\n  /** Date and time (UTC) when the model was last updated. */\n  lastUpdatedTime: string;\n  /**\n   * Training result of a model including its status, errors and diagnostics\n   * information.\n   */\n  modelInfo?: ModelInfoOutput;\n}\n\n/** Response of listing models. */\nexport interface ModelListOutput {\n  /** List of models. */\n  models: Array<AnomalyDetectionModelOutput>;\n  /** Number of trained multivariate models. */\n  currentCount: number;\n  /** Maximum number of models that can be trained for this Anomaly Detector resource. */\n  maxCount: number;\n  /** The link to fetch more models. */\n  nextLink?: string;\n}\n\n/** Results of last detection. */\nexport interface MultivariateLastDetectionResultOutput {\n  /** Variable Status. */\n  variableStates?: Array<VariableStateOutput>;\n  /** Anomaly status and information. */\n  results?: Array<AnomalyStateOutput>;\n}\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/paginateHelper.d.ts

@@ -0,0 +1,47 @@
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * Helper type to extract the type of an array
+ */
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+/**
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
+ */
+export type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+    /**
+     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+     */
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is `value`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} | {
+    body: {
+        models?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+//# sourceMappingURL=paginateHelper.d.ts.map

package/dist/esm/paginateHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,0BAA0B,EAAe,MAAM,oBAAoB,CAAC;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAG7E;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAC3B,QAAQ,EAAE,MAAM,EAChB,WAAW,CAAC,EAAE,MAAM,KACjB,OAAO,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SACzC;IACE,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACD;IACE,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAChC,GACD,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA4BvD"}

package/dist/esm/paginateHelper.js

@@ -0,0 +1,103 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { getPagedAsyncIterator } from "@azure/core-paging";
+import { createRestError } from "@azure-rest/core-client";
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export function paginate(client, initialResponse, options = {}) {
+    let firstRun = true;
+    // We need to check the response for success before trying to inspect it looking for
+    // the properties to use for nextLink and itemName
+    checkPagingRequest(initialResponse);
+    const { itemName, nextLinkName } = getPaginationProperties(initialResponse);
+    const { customGetPage } = options;
+    const pagedResult = {
+        firstPageLink: "",
+        getPage: typeof customGetPage === "function"
+            ? customGetPage
+            : async (pageLink) => {
+                const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();
+                firstRun = false;
+                checkPagingRequest(result);
+                const nextLink = getNextLink(result.body, nextLinkName);
+                const values = getElements(result.body, itemName);
+                return {
+                    page: values,
+                    nextPageLink: nextLink,
+                };
+            },
+    };
+    return getPagedAsyncIterator(pagedResult);
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+        throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    // value has to be an array according to the x-ms-pageable extension.
+    // The fact that this must be an array is used above to calculate the
+    // type of elements in the page in PaginateReturn
+    if (!Array.isArray(value)) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value ?? [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response) {
+    const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
+    if (!Http2xxStatusCodes.includes(response.status)) {
+        throw createRestError(`Pagination failed with unexpected statusCode ${response.status}`, response);
+    }
+}
+/**
+ * Extracts the itemName and nextLinkName from the initial response to use them for pagination
+ */
+function getPaginationProperties(initialResponse) {
+    // Build a set with the passed custom nextLinkNames
+    const nextLinkNames = new Set(["nextLink"]);
+    // Build a set with the passed custom set of itemNames
+    const itemNames = new Set(["value", "models"]);
+    let nextLinkName;
+    let itemName;
+    for (const name of nextLinkNames) {
+        const nextLink = initialResponse.body[name];
+        if (nextLink) {
+            nextLinkName = name;
+            break;
+        }
+    }
+    for (const name of itemNames) {
+        const item = initialResponse.body[name];
+        if (item) {
+            itemName = name;
+            break;
+        }
+    }
+    if (!itemName) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${[
+            ...itemNames,
+        ].join(" OR ")}`);
+    }
+    return { itemName, nextLinkName };
+}
+//# sourceMappingURL=paginateHelper.js.map

package/dist/esm/paginateHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.js","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AA6C1D;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAc,EACd,eAA0B,EAC1B,UAAoC,EAAE;IAItC,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,oFAAoF;IACpF,kDAAkD;IAClD,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACpC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAC5E,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,WAAW,GAA4B;QAC3C,aAAa,EAAE,EAAE;QACjB,OAAO,EACL,OAAO,aAAa,KAAK,UAAU;YACjC,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,KAAK,EAAE,QAAgB,EAAE,EAAE;gBACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;gBACvF,QAAQ,GAAG,KAAK,CAAC;gBACjB,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACxD,MAAM,MAAM,GAAG,WAAW,CAAW,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC5D,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,YAAY,EAAE,QAAQ;iBACvB,CAAC;YACJ,CAAC;KACR,CAAC;IAEF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,YAAqB;IACvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAI,IAAgC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,iBAAiB,YAAY,kCAAkC,CAAC,CAAC;IACnF,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAc,IAAa,EAAE,QAAgB;IAC/D,MAAM,KAAK,GAAI,IAAgC,CAAC,QAAQ,CAAQ,CAAC;IAEjE,qEAAqE;IACrE,qEAAqE;IACrE,iDAAiD;IACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B;IACzD,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAClG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,eAAsC;IACrE,mDAAmD;IACnD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,sDAAsD;IACtD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE/C,IAAI,YAAgC,CAAC;IACrC,IAAI,QAA4B,CAAC;IAEjC,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAI,eAAe,CAAC,IAAgC,CAAC,IAAI,CAAW,CAAC;QACnF,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,GAAG,IAAI,CAAC;YACpB,MAAM;QACR,CAAC;IACH,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAI,eAAe,CAAC,IAAgC,CAAC,IAAI,CAAW,CAAC;QAC/E,IAAI,IAAI,EAAE,CAAC;YACT,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,kFAAkF;YAChF,GAAG,SAAS;SACb,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;AACpC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PagedAsyncIterableIterator, PagedResult } from \"@azure/core-paging\";\nimport { getPagedAsyncIterator } from \"@azure/core-paging\";\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\n\n/**\n * Helper type to extract the type of an array\n */\nexport type GetArrayType<T> = T extends Array<infer TData> ? TData : never;\n\n/**\n * The type of a custom function that defines how to get a page and a link to the next one if any.\n */\nexport type GetPage<TPage> = (\n  pageLink: string,\n  maxPageSize?: number,\n) => Promise<{\n  page: TPage;\n  nextPageLink?: string;\n}>;\n\n/**\n * Options for the paging helper\n */\nexport interface PagingOptions<TResponse> {\n  /**\n   * Custom function to extract pagination details for crating the PagedAsyncIterableIterator\n   */\n  customGetPage?: GetPage<PaginateReturn<TResponse>[]>;\n}\n\n/**\n * Helper type to infer the Type of the paged elements from the response type\n * This type is generated based on the swagger information for x-ms-pageable\n * specifically on the itemName property which indicates the property of the response\n * where the page items are found. The default value is `value`.\n * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter\n */\nexport type PaginateReturn<TResult> = TResult extends\n  | {\n      body: { value?: infer TPage };\n    }\n  | {\n      body: { models?: infer TPage };\n    }\n  ? GetArrayType<TPage>\n  : Array<unknown>;\n\n/**\n * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension\n * @param client - Client to use for sending the next page requests\n * @param initialResponse - Initial response containing the nextLink and current page of elements\n * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results\n * @returns - PagedAsyncIterableIterator to iterate the elements\n */\nexport function paginate<TResponse extends PathUncheckedResponse>(\n  client: Client,\n  initialResponse: TResponse,\n  options: PagingOptions<TResponse> = {},\n): PagedAsyncIterableIterator<PaginateReturn<TResponse>> {\n  // Extract element type from initial response\n  type TElement = PaginateReturn<TResponse>;\n  let firstRun = true;\n  // We need to check the response for success before trying to inspect it looking for\n  // the properties to use for nextLink and itemName\n  checkPagingRequest(initialResponse);\n  const { itemName, nextLinkName } = getPaginationProperties(initialResponse);\n  const { customGetPage } = options;\n  const pagedResult: PagedResult<TElement[]> = {\n    firstPageLink: \"\",\n    getPage:\n      typeof customGetPage === \"function\"\n        ? customGetPage\n        : async (pageLink: string) => {\n            const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();\n            firstRun = false;\n            checkPagingRequest(result);\n            const nextLink = getNextLink(result.body, nextLinkName);\n            const values = getElements<TElement>(result.body, itemName);\n            return {\n              page: values,\n              nextPageLink: nextLink,\n            };\n          },\n  };\n\n  return getPagedAsyncIterator(pagedResult);\n}\n\n/**\n * Gets for the value of nextLink in the body\n */\nfunction getNextLink(body: unknown, nextLinkName?: string): string | undefined {\n  if (!nextLinkName) {\n    return undefined;\n  }\n\n  const nextLink = (body as Record<string, unknown>)[nextLinkName];\n\n  if (typeof nextLink !== \"string\" && typeof nextLink !== \"undefined\") {\n    throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);\n  }\n\n  return nextLink;\n}\n\n/**\n * Gets the elements of the current request in the body.\n */\nfunction getElements<T = unknown>(body: unknown, itemName: string): T[] {\n  const value = (body as Record<string, unknown>)[itemName] as T[];\n\n  // value has to be an array according to the x-ms-pageable extension.\n  // The fact that this must be an array is used above to calculate the\n  // type of elements in the page in PaginateReturn\n  if (!Array.isArray(value)) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${itemName}`,\n    );\n  }\n\n  return value ?? [];\n}\n\n/**\n * Checks if a request failed\n */\nfunction checkPagingRequest(response: PathUncheckedResponse): void {\n  const Http2xxStatusCodes = [\"200\", \"201\", \"202\", \"203\", \"204\", \"205\", \"206\", \"207\", \"208\", \"226\"];\n  if (!Http2xxStatusCodes.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n\n/**\n * Extracts the itemName and nextLinkName from the initial response to use them for pagination\n */\nfunction getPaginationProperties(initialResponse: PathUncheckedResponse) {\n  // Build a set with the passed custom nextLinkNames\n  const nextLinkNames = new Set([\"nextLink\"]);\n\n  // Build a set with the passed custom set of itemNames\n  const itemNames = new Set([\"value\", \"models\"]);\n\n  let nextLinkName: string | undefined;\n  let itemName: string | undefined;\n\n  for (const name of nextLinkNames) {\n    const nextLink = (initialResponse.body as Record<string, unknown>)[name] as string;\n    if (nextLink) {\n      nextLinkName = name;\n      break;\n    }\n  }\n\n  for (const name of itemNames) {\n    const item = (initialResponse.body as Record<string, unknown>)[name] as string;\n    if (item) {\n      itemName = name;\n      break;\n    }\n  }\n\n  if (!itemName) {\n    throw new Error(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${[\n        ...itemNames,\n      ].join(\" OR \")}`,\n    );\n  }\n\n  return { itemName, nextLinkName };\n}\n"]}

package/dist/esm/parameters.d.ts

@@ -0,0 +1,46 @@
+import type { RequestParameters } from "@azure-rest/core-client";
+import type { UnivariateDetectionOptions, UnivariateChangePointDetectionOptions, ModelInfo, MultivariateBatchDetectionOptions, MultivariateLastDetectionOptions } from "./models.js";
+export interface DetectUnivariateEntireSeriesBodyParam {
+    /** Method of univariate anomaly detection. */
+    body: UnivariateDetectionOptions;
+}
+export type DetectUnivariateEntireSeriesParameters = DetectUnivariateEntireSeriesBodyParam & RequestParameters;
+export interface DetectUnivariateLastPointBodyParam {
+    /** Method of univariate anomaly detection. */
+    body: UnivariateDetectionOptions;
+}
+export type DetectUnivariateLastPointParameters = DetectUnivariateLastPointBodyParam & RequestParameters;
+export interface DetectUnivariateChangePointBodyParam {
+    /** Method of univariate anomaly detection. */
+    body: UnivariateChangePointDetectionOptions;
+}
+export type DetectUnivariateChangePointParameters = DetectUnivariateChangePointBodyParam & RequestParameters;
+export type GetMultivariateBatchDetectionResultParameters = RequestParameters;
+export interface TrainMultivariateModelBodyParam {
+    /** Model information. */
+    body: ModelInfo;
+}
+export type TrainMultivariateModelParameters = TrainMultivariateModelBodyParam & RequestParameters;
+export interface ListMultivariateModelsQueryParamProperties {
+    /** Skip indicates how many models will be skipped. */
+    skip?: number;
+    /** Top indicates how many models will be fetched. */
+    top?: number;
+}
+export interface ListMultivariateModelsQueryParam {
+    queryParameters?: ListMultivariateModelsQueryParamProperties;
+}
+export type ListMultivariateModelsParameters = ListMultivariateModelsQueryParam & RequestParameters;
+export type DeleteMultivariateModelParameters = RequestParameters;
+export type GetMultivariateModelParameters = RequestParameters;
+export interface DetectMultivariateBatchAnomalyBodyParam {
+    /** Request of multivariate anomaly detection. */
+    body: MultivariateBatchDetectionOptions;
+}
+export type DetectMultivariateBatchAnomalyParameters = DetectMultivariateBatchAnomalyBodyParam & RequestParameters;
+export interface DetectMultivariateLastAnomalyBodyParam {
+    /** Request of last detection. */
+    body: MultivariateLastDetectionOptions;
+}
+export type DetectMultivariateLastAnomalyParameters = DetectMultivariateLastAnomalyBodyParam & RequestParameters;
+//# sourceMappingURL=parameters.d.ts.map

package/dist/esm/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EACV,0BAA0B,EAC1B,qCAAqC,EACrC,SAAS,EACT,iCAAiC,EACjC,gCAAgC,EACjC,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,qCAAqC;IACpD,8CAA8C;IAC9C,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED,MAAM,MAAM,sCAAsC,GAAG,qCAAqC,GACxF,iBAAiB,CAAC;AAEpB,MAAM,WAAW,kCAAkC;IACjD,8CAA8C;IAC9C,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED,MAAM,MAAM,mCAAmC,GAAG,kCAAkC,GAClF,iBAAiB,CAAC;AAEpB,MAAM,WAAW,oCAAoC;IACnD,8CAA8C;IAC9C,IAAI,EAAE,qCAAqC,CAAC;CAC7C;AAED,MAAM,MAAM,qCAAqC,GAAG,oCAAoC,GACtF,iBAAiB,CAAC;AACpB,MAAM,MAAM,6CAA6C,GAAG,iBAAiB,CAAC;AAE9E,MAAM,WAAW,+BAA+B;IAC9C,yBAAyB;IACzB,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,MAAM,gCAAgC,GAAG,+BAA+B,GAAG,iBAAiB,CAAC;AAEnG,MAAM,WAAW,0CAA0C;IACzD,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gCAAgC;IAC/C,eAAe,CAAC,EAAE,0CAA0C,CAAC;CAC9D;AAED,MAAM,MAAM,gCAAgC,GAAG,gCAAgC,GAAG,iBAAiB,CAAC;AACpG,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;AAClE,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAE/D,MAAM,WAAW,uCAAuC;IACtD,iDAAiD;IACjD,IAAI,EAAE,iCAAiC,CAAC;CACzC;AAED,MAAM,MAAM,wCAAwC,GAAG,uCAAuC,GAC5F,iBAAiB,CAAC;AAEpB,MAAM,WAAW,sCAAsC;IACrD,iCAAiC;IACjC,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED,MAAM,MAAM,uCAAuC,GAAG,sCAAsC,GAC1F,iBAAiB,CAAC"}

package/dist/esm/parameters.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=parameters.js.map